...
| 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 can have both positive and negative targetings, negative targeting features set is customisable.
RTBSuite supports the following targeting list:
...
| Targeting | Type | Description |
|---|---|---|
| geo | object | Placeholder for geo targetings |
geo.countries | array of strings | ISO 3166-1 alpha2 county codes |
geo.regions | array of strings | Country region codes |
geo.cities | array of strings | Cities |
geo.dma_code | array of strings | DMA codes |
geo.zip_code | array of strings | Zip codes |
| segments | array of strings | User segment targeting |
| categories | array of strings | IAB content category targeting |
frequency_capping | object | Frequency capping |
frequency_capping.week | integer | Impressions per week (optional) |
frequency_capping.day | integer | Impressions per day (optional) |
frequency_capping.hour | integer | Impressions per hour (optional) |
weekdays | array of integerintegers | Weekday targeting: 1(Monday)..7(Sunday) |
time | array of integerintegers | Hour targeting: 0..23 |
| ssps | array of strings | SSP targeting |
| page_language | array of strings | Browser language |
devices | array of strings | Device targeting: "DESKTOP","SMARTPHONE","TABLET" |
positions | array of strings | Position: "above","below","unknown" |
operating_systems | array of strings | Operating systems targeting: "IOS","ANDROID","WINDOWS","LINUX","MACOS","OTHER","WINDOWS_PHONE" |
browsers | array of strings | Browser targeting: "FIREFOX","IE","EDGE","OPERA","YANDEX","CHROME","SAFARI","ANDROID_BROWSER","OTHER" |
| domain_lists | array of integers | Domain list ID targeting (usually negative) |
Campaigns group
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "1",
"name": "Test",
"advertiser_id": "2",
"budget_limit": "100000.00"
} |
...