...
| 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 |
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.app_id | no | string | Application ID feature. Example: "com.instagram.android", "389801252" |
| 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 |
Example
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
"financing": {
"type": "max_cpm",
"price": "3",
"dynamic_prices": [
{
"id": 1,
"price": 5,
"features": {
"ssp": "bsw.brx"
}
},
{
"id": 2,
"price": 6,
"features": {
"ssp": "bsw.vi",
"domain": "*.google.com"
}
},
{
"id": 3,
"price": 10,
"features": {
"ssp": "adx",
"device": "SMARTPHONE",
"domain": "cnn.com"
}
}
]
} |
Campaign targetings
Campaign can have both positive and negative targetings, negative targeting features set is customisable.
...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "http://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge",
"advertiser_id": 27,
"creative_type": "native_creatives",
"landing_page": "http://whoabella.com/monitordtr.php?i=pp.s1&url=http://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge/?utm_source=getintent&utm_medium=referral&utm_campaign=3bluemedia_camp1_cv1",
"assets": [
{
"type": "img",
"url": "nm.contextweb.com/media/1434570383-connected_cast.jpg",
"image_type": 3,
"size": "300x260"
},
{
"type": "title",
"text": "Check Out Latest Episode Of 'Connected'"
},
{
"type": "data",
"data_type": 1,
"value": "Whoa Bella!"
},
{
"type": "data",
"data_type": 2,
"value": "We've been rooting for Rosie's career to take off for a long time. Anyone can see that she's crazy talented, gorgeous and really freakin' deserves her big break and the sooner the better.\n\n"
}
]
} |
Native Video Examples
...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "http://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge",
"advertiser_id": 27,
"creative_type": "native_creatives",
"landing_page": "http://whoabella.com/monitordtr.php?i=pp.s1&url=http://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge/?utm_source=getintent&utm_medium=referral&utm_campaign=3bluemedia_camp1_cv1",
"assets": [
{
"type": "video",
"file": {
"url": "http://cdn.liverail.com/adasset4/1331/229/7969/me.mp4",
"file_size" : 1280000,
"size": "640x480"
},
"duration": 7,
"required": true
}
]
} |
...
| 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
|
Site object
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "http://test.com",
"advertiser_id": 27,
"click_control": "false",
"feed_url": "http://names.ru/bitrix/catalog_export/rtb.xml"
} |
...
| 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 |
...