Update Zone

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

Updates the specific Zone by setting the values of the parameters passed. Any parameters not provided will be left unchanged

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Request Body Schema
Arrow
Name
Description
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
descriptionstring
A more detailed description of the Zone.


Example: This is my first zone.
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
statusstringrequired
Zone status.


Example: active

Possible values: active | verification | rejected | paused | inactive | archived
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
Response status codes
Arrow
204 - No Content
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the zone.
2 We recommend using containers instead of tags, as tags are deprecated. If both parameters are sent, containers will take priority.
tip
1 If you don't know the zone id, list the zones to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "demo",
  "status": "implementing",
  "revenue_share": "90",
  "description": "testing"
}