...
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Advertiser name |
url | no | string | Advertiser domain |
default_dsp_commission | no | float | Default DSP commission for any advertiser campaign |
default_agency_commission | no | float | Default agency commission for any advertiser campaign |
currency | no | string | Advertiser currency |
hide_billing | no | boolean | Activating/hiding financial info in UI |
manage_campaigns_commissions | no | boolean | Activates managing DSP/Agency commissions at campaign level (UI) |
credit | no | float | Advertiser overspend limit |
...
| 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 |
...
RTBSuite supports the following targeting list:
| Targeting | Type | Description |
|---|---|---|
geo | object | Placeholder for geo targetings |
| array of strings | ISO 3166-1 alpha2 county codes |
| array of strings | Country region codes |
| array of strings | Cities |
| array of strings | DMA codes |
| array of strings | Zip codes |
segments | array of strings | User segment targeting |
categories | array of strings | IAB content category targeting |
| object | Frequency capping |
| integer | Impressions per week (optional) |
| integer | Impressions per day (optional) |
| integer | Impressions per hour (optional) |
| array of integers | Weekday targeting: 1(Monday)..7(Sunday) |
| array of integers | Hour targeting: 0..23 |
ssps | array of strings | SSP targeting |
page_language | array of strings | Browser language |
| array of strings | Device targeting: "DESKTOP","SMARTPHONE","TABLET" |
| array of strings | Position: "above","below","unknown" |
| array of strings | Operating systems targeting: "IOS","ANDROID","WINDOWS","LINUX","MACOS","OTHER","WINDOWS_PHONE" |
| array of strings | Browser targeting: "FIREFOX","IE","EDGE","OPERA","YANDEX","CHROME","SAFARI","ANDROID_BROWSER","OTHER" |
domains | array of strings | Excluded domains (usually for negative targeting only) |
domains_lists | array of integers | Domain list ID targeting (usually for negative targeting only) |
...
| Attribute | Required | Type | Description |
|---|---|---|---|
advertiser_id | yes | integer | Advertiser Id |
name | yes | string | Advertiser name |
budget_limit | yes | float | Budget limit for the group of campaigns |
...
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Domain list name |
domains | yes | array of strings | Domains |
...
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Creative name |
advertiser_id | yes | integer | Advertiser Id |
creative_type | yes | string | Creative type, enum value: "plain"/"3rd_party_creatives"/"dynamic_creatives""video"/"native_creatives" |
| no | string | Landing page URL (with macros) |
assets | no | array of objects | Native creative assets |
| yes | string | Asset type, enum value: "img","title","data","video" |
| yes | integer | IAB data asset type
|
...
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Creative name |
advertiser_id | no | integer | Advertiser Id |
type | yes | string | Segment type, enum value: "standard"/"3rd_party" |
| no | string | 3rd party segment Id |
price | no | float | Segment price (CPM) |
currency
| no | string | Segment currency |
terms | no | object | Segment rules |
Snippet
...