...
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Campaign name |
currency | yes | string | ISO-4217 currency code |
starts | yes | YYYY-MM-DD HH:MM:SS formatted string | Campaign start time (UTC) |
ends | yes | YYYY-MM-DD HH:MM:SS formatted string | Campaign end time (UTC) |
for_mobile_device | no | boolean | Is in-app campaign (default false) |
group_id | no | integer | Campaign groupId in case campaign is sharing budget with other campaigns |
creative_type | yes | string |
Campaign creative type, enum value "plain"/"3rd_party_creatives"/"dynamic_creatives""video"/"native_creatives" |
budget | yes | float | Campaign budget |
disabled | no | boolean | Activates/stops campaign (default false) |
financing | yes | object | Campaign pricing model |
commissions | no | object | DSP/Agency commissions in case commissions are calculated on RTBSuite side Is required only in case advertiser allows to manage campaign commissions (manage_campaign_commissions = true). |
landing_page | yes | string | Declared campaign landing page URL |
daily_budget | no | float | Campaign budget limit |
site_id | no | integer | Campaign related site object |
creatives | yes | array of integers | Campaign creatives |
targeting | yes | object | Campaign positive targetings |
negative_targeting | no | object | Campaign negative targetings |
Campaign Financing
| Attribute | Required | Type | Description |
|---|---|---|---|
| type | yes | string | Type of financing: fixed_cpm, max_cpm, target_cpc, target_cpmv, fixed_cpc, target_cpa |
| price | yes | string | Price value. |
| dynamic_prices | no | array of object | Dynamic pricing configuration. See table below for object description. |
Campaign Dynamic Financing
| Attribute | Required | Type | Description |
|---|---|---|---|
| id | yes | number | Unique ID |
| price | yes | number | Price for the current set of features. |
| features | yes | object | Features for the current price |
| features.ssp | no | string | SSP name feature. Example: "adx" |
| features.browser | no | string | Browser name feature. Values: FIREFOX, IE, EDGE, OPERA, YANDEX, ANDROID_BROWSER, CHROME, SAFARI, FACEBOOK_APP |
| features.device | no | string | Device type feature. Values: UNKNOWN, SMARTPHONE, TABLET, DESKTOP, SMART_TV, GAME_CONSOLE |
| features.domain | no | string | Domain feature. Example: "*.google.com", "facebook.com" |
| features.size | no | string | Creative Size feature. Example: "320x240" |
| features.os | no | string | Operating System feature. IOS, ANDROID, WINDOWS, LINUX, MACOS, OTHER, WINDOWS_PHONE, BLACKBERRY |
Campaign targetings
Campaign can have both positive and negative targetings, negative targeting features set is customisable.
...