List Zone placements

GET /zones/{id}/placements
Copied
Arrow
                https://api.ocamba.com/v2/adex/zones/{id}/placements

Returns a list of Zone placements

path Parameters
Arrow
Name
Description
zone_idstringrequired
Unique zone identifier.


Example: zone_id=1000001
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=lname → API retuns a certain resource whose lname contains string 'sou'.
GET /VERSION/adex/RESOURCE_NAME?q=sou&q_fields=fname,lname,email → API returns a certain resource that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.
qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /VERSION/adex/RESOURCE_NAME?q=sou → returns a certain resource that contain string 'sou'

See tips for the list of searchable parameters.

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ zone-placement ]
An array of all created items.
Zone Placement
Name
Description
company_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1000000
confobject
Placement configuration options.
Name
Description
js_code_execinteger
Exec desc


Example: 1

Possible values: 0 | 1
wrapstring
Wrap desc


Example: iframe

Possible values: none | iframe | shadow-root

Default: iframe
create_timestring
Timezone: GMT.


Example: 2022-10-29 12:47:00
descriptionstring
Placement desc. Maximum 2000 characters.


Example: Here goes description.
idstring
Placement ID generated by the clients. ID may only contain letters, numbers, dashes and underscores. Case insensitive. Max 40 characters.


Example: TOP_LEFT
layouts[ string ]
Array of layout ids generated by the ocamba platform. Maximum of 10 items.
namestring
Placement name. Maximum 100 characters.


Example: My first placement
tagstring
Zone placement tag used when implementing display zones.


Example:

track_idstring
Zone tracker.


Example: AF6PgAAtzeU
unit_size[ string ]
Array of standardised ad unit sizes by IAB. Length limited by subscription plan.
update_timestring
Timezone: GMT.


Example: 2022-10-30 14:27:26
zone_idstring
A unique zone identifier generated by the Ocamba platform.


Example: 1000001
totalinteger
A total number of items.


Example: 92
info
1 Placements are only available on display zones.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 92,
  "items": [
    {
      "id": "TOP_LEFT",
      "company_id": "1000000",
      "zone_id": "1000001",
      "track_id": "AF6PgAAtzeU",
      "tag": "<div class=\\\"axocmba\\\" data-slot=“feed.feed-name.com/AF6PgAAtzeU/l1”></div>",
      "name": "My first placement",
      "description": "Here goes description.",
      "layouts": [
        [
          "banner"
        ]
      ],
      "unit_size": [
        "300x250"
      ],
      "conf": {
        "wrap": "iframe",
        "js_code_exec": 1
      },
      "create_time": "2022-10-29 12:47:00",
      "update_time": "2022-10-30 14:27:26"
    }
  ]
}