Create Zone

POST /zones
Copied
Arrow
                https://api.ocamba.com/v2/adex/zones

Creates a new Zone object

Request Body Schema
Arrow
Name
Description
account_idstringrequired
A unique account identifier generated by the Ocamba platform.


Example: 10073337
bid_floorfloat
Minimum value is 0, maximum is 100. Required if bid_floor_priority is 1.


Example: 32.5
bid_floor_prioritynumber (integer)
Priority over bid floor in the request.

Possible values: 0 | 1
campaign_prioritystringrequired
Campaign priority.


Example: compete

Possible values: local | bacfill | unfilled | compete

Default: compete
campaign_search_algostringrequired
Campaign algorithm to choose a campaigns competing method.


Example: round-robin

Possible values: round-robin | multi-armed-bandit | internal-sort-by-bid

Default: round-robin
cpv_viewabilitynumber (integer)
cpv_viewability is taken into account only if pricing model is set to cpv (Cost-Per-View).


Example: 15
descriptionstring
A more detailed description of the Zone.


Example: This is my first zone.
external_expl_ratenumber (integer)required
The approximate rate of total bidRequests to chosen algorithm. Only external campaigns are affected and rate value is expressed in percentage. Not usable on round-robin. Minimum value: 0, maximum value: 100.


Example: 15

Default: 5
filterszone-filtersrequired
Filters object.
Zone Filters
Name
Description
flash_filternumber (integer)
Passthrough/block click and report as spam if requested caller browser does not support Flash.

Possible values: 0 | 1
ip_matchnumber (integer)
Passthrough/block click and report as spam if received IP does not match the requested one.


Example: 1

Possible values: 0 | 1
java_script_filternumber (integer)
Passthrough/block click and report as spam if requested caller browser does not support JavaScript.

Possible values: 0 | 1
max_click_delaynumber (integer)
Maximum time to allow click on the link to be valid from time link was generated, if delays are matched click is considered spam. Maximum value is 86400000.


Example: 86400000
min_click_delaynumber (integer)
Minimum time to allow click to be valid from the time the link was generated if the delay is matched click is considered spam. Maximum value is 100000.


Example: 1500
non_empty_referernumber (integer)
Passthrough/block click and report as spam if received HTTP referrer is empty.

Possible values: 0 | 1
policystring
Filter click policy.


Example: block

Possible values: block | passthrough
referrer_matchnumber (integer)
Passthrough/block click and report as spam if received referrer does not match the requested one.

Possible values: 0 | 1
user_agent_matchnumber (integer)
Passthrough/block click and report as spam if the received HTTP user agent does not match requested.

Possible values: 0 | 1
valid_user_agentnumber (integer)
Passthrough/block click and report as spam if the received HTTP user agent is not in the list of valid ones.

Possible values: 0 | 1
namestringrequired
Zone name.


Example: example_zone_name
pricing_modelstringrequired
Assigning the wanted pricing model to bid modifier.


Example: cpc

Possible values: none | cpm | cpc | cpv
response_timeoutnumber (integer)required
Defines minimum and/or maximum acceptable response time, expressed in milliseconds. Minimum value is 100, maximum 1000.


Example: 250
revenue_sharenumber (integer)
Value is expressed as a percentage of income shared with an advertiser. Minimum value is 0, maximum is 100. Changing the default value is limited by the subscription plan.


Example: 30

Default: 100
search_algo_expl_ratenumber (integer)required
The approximate rate of total bidRequests to chosen algorithm. Only internal campaigns are affected and rate value is expressed in percentage. Not usable on round-robin. Minimum value: 0, maximum value: 100.


Example: 10

Default: 5
seatzone-seats
Seat object.
Zone Seat
Name
Description
itemsarray
If type is "account" every item must be unique and a valid account id. If type is "campaign" every item must be unique and a valid campaign id. If type is "campaign-group" every item must be unique and a valid group id. Maximum length is limited by subscription plan.


Example: 12343141,23526321,98761234
prioritynumber (integer)
Priority over query in request.


Example: 1

Possible values: 0 | 1

Default: 1
typestring
Describes type of zone seats.


Example: account

Possible values: account | campaign | campaign_group
statusstringrequired
Zone status.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived
subid_hashobject

Name
Description
enabledinteger
Apply subid hashing to all campaigns.


Example: 1

Possible values: 0 | 1
keystring
Hashing key. The key may only contain letters, numbers, dashes and underscores.


Example: my_key
targetingzone-targeting
Targeting object.
Zone Targeting
Name
Description
browsersobject

Name
Description
items[ object ]
Array of browser items, maximum length limited by subscription plan.
categoriesobject

Name
Description
items[ string ]
Array of valid category names supported by Ocamba, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type category, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
connectionsobject

Name
Description
items[ string ]
Array of valid connection types supported by Ocamba.
opstring



Example: nin

Possible values: in | nin
containersobject

Name
Description
items[ string ]
Array of strings containing containers ids. Maximum length limited by subscription plan.
opstring
String describing operation.


Example: in

Possible values: in
countriesobject

Name
Description
items[ string ]
Array of country codes supported by ocamba (ISO 3166-1, 2 letter country codes), maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type country, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
device_manufacturersobject

Name
Description
items[ string ]
Array of device manufacturer ids, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
device_trackingnumber (integer)
Describes the status of device tracking.


Example: 1

Possible values: 0 | 1
device_typesobject

Name
Description
items[ string ]
Array of device types, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in | nin
has_user_datanumber (integer)
Describes the availability of user data


Example: 1

Possible values: 0 | 1
ipobject

Name
Description
items[ string ]
Array of ips, each element must be a valid ipv4, ipv6 or cidr format for both v4 and v6, maximum length limited by subscription plan. Required if lists is not present.


Example: 123.523.123.4,123.523.123.4/12,2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23,2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type ip, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
languagesobject

Name
Description
items[ string ]
Array of unique strings. Each element must be a valid 2-letter language code supported by Ocamba platform, maximum number of items limited by subscription plan.
opstring



Example: nin

Possible values: in | nin
osobject

Name
Description
items[ object ]
Array of os items, maximum length limited by subscription plan.
pagesobject

Name
Description
items[ string ]
Array of domains, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type domain, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
regionsobject

Name
Description
items[ string ]
Array of region ids generated by the Ocamba platform, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type region, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
subidsobject

Name
Description
items[ string ]
Array of subids, maximum length limited by subscription plan. Required if lists is not present.
lists[ string ]
Array of list ids created by the Ocamba platform. Lists must be of type subid, maximum length limited by subscription plan. Required if items is not present.
opstring



Example: in

Possible values: in | nin
tagsobject

Name
Description
items[ string ]
Array of tag ids, maximum length limited by subscription plan. This field is deprecated and will be removed in future. Please use container as a replacement.
opstring



Example: in

Possible values: in | nin
timeobject

Name
Description
items[ string ]
Array of valid cron expressions, maximum length limited by subscription plan.
opstring



Example: in

Possible values: in
typestringrequired
Zone type.


Example: rtb

Possible values: rtb | display | native | vast | widget | push | mobile-sdk | smartlink
user_cachenumber (integer)
Turn on/off user cache. Only available on push zones.


Example: 1

Possible values: 0 | 1
widgets[ string ]
Array of widget ids, created on the Ocamba platform, max 10 items. Available only for zones of type Widget.
Response status codes
Arrow
201 - Created
Arrow

info
1 Widgets are only available for zones of type widget.
2 User_cache is only available for zones of type push.
note
1 We recommend using containers instead of tags, as tags are deprecated. If both parameters are sent, containers will take priority.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
    "name": "example_zone_name",
    "description": "This is my first zone.",
    "status": "active",
    "type": "rtb",
    "pricing_model": "cpc",
    "campaign_priority" : "compete",
    "account_id": "10073337",
    "search_algo_expl_rate" : 10,
    "external_expl_rate": 15,
    "response_timeout": 250,
    "revenue_share" : 30,
    "bid_floor": 32.5,
    "subid_hash": {
        "key": "my_key",
        "enabled": 1
    }
    "user_cache": 1,
    "widgets": [
      "788"
    ],
    "targeting": {
      "countries": {
        "items": [
          "RS"
        ],
        "lists": [
          "1838"
        ],
        "op": "in"
      },
      "regions": {
        "items": [
          "2661876"
        ],
        "lists": [
          "2934"
        ],
        "op": "in"
      },
      "subids": {
        "items": [
          "fut_t10_18-24-MULTI_GG"
        ],
        "lists": [
          "1835"
        ],
        "op": "in"
      },
      "ip": {
        "items": [
          "123.523.123.4", "123.523.123.4/12", "2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23", "2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334"
        ],
        "lists": [
          "2691"
        ],
        "op": "in"
      },
      "pages": {
        "items": [
          "ocamba.com"
        ],
        "lists": [
          "2725"
        ],
        "op": "in"
      },
      "categories": {
        "items": [
          "IAB1", "IAB1-1", "IAB2"
        ],
        "lists": [
          "2733"
        ],
        "op": "in"
      },
      "containers": {
        "items": [
          "1303"
        ],
        "op": "in"
      },
      "device_types": {
        "items": [
          "console"
        ],
        "op": "in"
      },
      "device_manufacturers": {
        "items": [
          "13"
        ],
        "op": "in"
      },
      "os": {
        "items": [
          {
            "id": "12",
            "op": "in",
            "versions": [
              "10.0"
            ]
          }
        ]
      },
      "browsers": {
        "items": [
          {
            "id": "10",
            "op": "in",
            "versions": [
              "10.0"
            ]
          }
        ]
      },
      "connections": {
        "items": [
          "1"
        ],
        "op": "nin"
      },
      "time": {
        "items": [
          "[0,15,30,45 12,13,14 * 6 1]"
        ],
        "op": "in"
      },
      "device_tracking": 1,
      "has_user_data": 1
    },
    "filters": {
      "policy": "block",
      "ip_match": 1,
      "max_click_delay": 86400000,
      "min_click_delay": "1500"
    },
    "create_time": "2021-10-29 12:47:00",
    "update_time": "2021-10-30 14:27:26"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "3002792",
  "track_id": "00000000000971895032",
  "company_id": "7196310",
  "account_id": "10073337",
  "creator_id": "1000222",
  "name": "example_zone_name",
  "description": "This is my first zone.",
  "status": "active",
  "type": "rtb",
  "pricing_model": "cpc",
  "campaign_priority": "compete",
  "campaign_search_algo": "round-robin",
  "search_algo_expl_rate" : 10,
  "external_expl_rate": 15,
  "response_timeout": 250,
  "revenue_share" : 30,
  "bid_floor": 32.5,
  "subid_hash": { 
      "key": "my_key",
      "enabled": 1
  }
  "user_cache": 1,
  "widgets": [
    "788"
  ],
  "targeting": {
    "countries": {
      "items": [
        "RS"
      ],
      "lists": [
        "1838"
      ],
      "op": "in"
    },
    "regions": {
      "items": [
        "2661876"
      ],
      "lists": [
        "2934"
      ],
      "op": "in"
    },
    "subids": {
      "items": [
        "fut_t10_18-24-MULTI_GG"
      ],
      "lists": [
        "1835"
      ],
      "op": "in"
    },
    "ip": {
      "items": [
        "123.523.123.4", "123.523.123.4/12", "2001:0db8:85a3:33a1:ff12:8a2e:0370:7334/23", "2301:01b8:f5a3:43a1:afc2:8c2e:0370:7334"
      ],
      "lists": [
        "2691"
      ],
      "op": "in"
    },
    "pages": {
      "items": [
        "ocamba.com"
      ],
      "lists": [
        "2725"
      ],
      "op": "in"
    },
    "categories": {
      "items": [
        "IAB1", "IAB1-1", "IAB2"
      ],
      "lists": [
        "2733"
      ],
      "op": "in"
    },
    "containers": {
      "items": [
        "1303"
      ],
      "op": "in"
    },
    "device_types": {
      "items": [
        "console"
      ],
      "op": "in"
    },
    "device_manufacturers": {
      "items": [
        "13"
      ],
      "op": "in"
    },
    "os": {
      "items": [
        {
          "id": "12",
          "op": "in",
          "versions": [
            "10.0"
          ]
        }
      ]
    },
    "browsers": {
      "items": [
        {
          "id": "10",
          "op": "in",
          "versions": [
            "10.0"
          ]
        }
      ]
    },
    "connections": {
      "items": [
        "1"
      ],
      "op": "nin"
    },
    "time": {
      "items": [
        "[0,15,30,45 12,13,14 * 6 1]"
      ],
      "op": "in"
    },
    "device_tracking": 1,
    "has_user_data": 1
  },
  "filters": {
    "policy": "block",
    "ip_match": 1,
    "max_click_delay": 86400000,
    "min_click_delay": "1500"
  },
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}