...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "21",
"name": "Any advertiser",
"url": "http://advertiser.domain/",
"default_dsp_commission": "35",
"currency": "USD",
"prepayment_mode": "false",
"hide_billing": "true",
"credit": 10000,
"max_budget": 4707.27
} |
Advertiser attributes
"max_budget": 4707.27
} |
Advertiser attributes
| Attribute | Required | Type | Description |
|---|
name | yes | string | Advertiser name |
url | no | string | Advertiser domain |
currency | no |
default_agency_commissionhide_billingmanage_campaigns_commissionscreditCampaign
Browser campaign
| string | Advertiser currency |
Campaign
Browser campaign
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test campaign!",
"advertiser_id": 27,
"starts": "2013-11-12 00:00:00",
"ends": "2014-03-09 22:59:59",
"currency": " | ||||||
| Блок кода | ||||||
| ||||||
{ "name": "Test campaign!", "advertiser_id": 27, "test-field": "test", "starts": "2013-11-12 00:00:00", "ends": "2014-03-09 22:59:59", "currency": "USD", "creatives_type": "plain", "landing_page": "http://getintent.com", "disabled": true, "budget": 1000, "financing": { "type": "max_cpm", "price": 3.5 }, "commissionsgroup_id": {0, "agencytargeting": "0",{ "dsp": "10" }, "group_id": 0, "targeting": { "geogeo": { "countries": [ "US" ], "regions": [ "US/FL", "US/PA", "US/NJ" ], "cities": [ "Jersey City", "Houston" ], "dma_code": [ "500", "502" ], "zip_code": [ "10010" ] }, "segments": [ 1009, 1048, 1050, 1071 ], "categories": [ "iab2", "iab2-1", "iab2-2", "iab2-3", "iab2-12" ], "frequency_capping": { "hour": 4, "day": 10, "week": 30 }, "weekdays": [ "1", "2", "3", "4", "5", "6", "7" ], "time": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "0" ], "ssps": [ "goog", "bsw.rubicon", "bsw.pubmatic" ], "page_language": [ "en" ], "devices": [ "DESKTOP", "SMARTPHONE", "TABLET" ], "positions": [ "above", "below", "unknown" ], "operating_systems": [ "IOS", "ANDROID", "WINDOWS", "LINUX", "MACOS", "OTHER", "WINDOWS_PHONE" ], "browsers": [ "FIREFOX", "IE", "EDGE", "OPERA", "YANDEX", "CHROME", "SAFARI", "ANDROID_BROWSER", "OTHER" ] }, "negative_targeting": { "domains_lists": [ "6" ] }, "daily_budget": 12, "site_id": 42, "creatives": [ 210, 3013, 3014, 3015, 3016, 3017, 3018, 3019, 3020, 3021, 3022, 3023, 3024 ] } |
...
| Блок кода | ||
|---|---|---|
| ||
{
"name": "In app campaign",
"advertiser_id": "26",
"starts": "2015-01-02 21:00:00",
"ends": "2015-01-11 20:59:59",
"group_id": "181",
"currency": "USD",
"budget": "3000",
"financing": {
"type": "max_cpm",
"price": "3.25"
},
"targeting": {
"devices": [
"SMARTPHONE"
],
"geo": {
"regions": [
"77",
"78"
]
},
"mobile": {
"application_category": [
"Business",
"IT&Gadgets",
"Education&Science",
"Reference"
]
},
"frequency_capping": {
"day": "10",
"week": "30"
},
"operating_systems": [
"IOS"
]
},
"creatives_type": "plain",
"landing_page": "https://...",
"disabled": true,
"commissionsfor_mobile_device": {
"true",
"agencynegative_targeting": 0,{
"dspmobile": "15"{
},
"for_mobile_deviceapplication": "true",[
"negative_targeting": {
"555717978",
"mobile": {
"application866990710": [,
"555717978799442576",
]
"866990710",
}
"799442576"
]
}
},},
"creatives": [
"6869",
"6870",
"6871",
"6872",
"6873",
"6874",
"6875",
"6876"
]
} |
Campaign attributes
| 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 |
daily_budgetlanding_page | yes | string | Declared campaign landing page URL |
daily_budget | no |
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).
| 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 targetings
Campaign can have both positive and negative targetings, RTBSuite supports the following targeting list:
fp_switch | no | string | Fillrate predictor "on" - enabled "off" - disabled "inherit" - inherit fillrate predictor state from advertiser |
budget_pacing | no | string | Campaign budget pacing. Values: "DAILY", "CAMPAIGN" (default "CAMPAIGN"). |
Campaign Financing
| Attribute | Required |
|---|
| Type | Description |
|---|
| type |
geo.countries
geo.regions
geo.cities
geo.dma_code
geo.zip_code
frequency_capping frequency_capping.week frequency_capping.day frequency_capping.hourweekdaystimedevicesDevice targeting: "DESKTOP","SMARTPHONE","TABLET"
positionsoperating_systemsOperating systems targeting: "IOS","ANDROID","WINDOWS","LINUX","MACOS","OTHER","WINDOWS_PHONE"
browsersBrowser targeting: "FIREFOX","IE","EDGE","OPERA","YANDEX","CHROME","SAFARI","ANDROID_BROWSER","OTHER"
...
| 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 | Micro Bidding 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 |
| features.segment_id | no | number | Segment id feature. Example: 16951 |
Example
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "id"financing": { "type": "1max_cpm", "name "price": "Test3", "advertiser_id": "2", "dynamic_prices": [ { "id": 1, "price": 5, "features": { "ssp": "bsw.brx", "budget_limit": "100000.00" } |
Campaign group attributes
| 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 |
Domains list
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test list",
"advertiser_id": 27,
"domains": [
"yandex.ru",
"google.com",
"yahoo.com"
]
} |
Domain list attributes
| Attribute | Required | Type | Description |
|---|---|---|---|
| name | yes | string | Domain list name |
| domains | yes | array of strings | Domains |
Creative
...
| language | js |
|---|---|
| title | Standard Creative Example |
| linenumbers | true |
...
"segment_id": 1000
}
},
{
"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.
GetIntent supports the following targeting list:
| Targeting | Type | Description |
|---|---|---|
geo | object | Placeholder for geo targetings |
| array of strings | Country 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 |
segments_all | array of strings | User segment targeting - all at once |
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) |
Domains_lists/domains targeting can not be used simultaneously, only one targeting should be applied.
Geo taxonomy depend on GeoIP provider (different providers use different lists for country/regions).
Campaigns group
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "1",
"name": "Test",
"advertiser_id": "2",
"budget_limit": "100000.00"
} |
Campaign group attributes
| 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 |
Domains list
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test list",
"advertiser_id": 27,
"domains": [
"yandex.ru",
"google.com",
"yahoo.com"
]
} |
Domain list attributes
| Attribute | Required | Type | Description |
|---|---|---|---|
name | yes | string | Domain list name |
domains | yes | array of strings | Domains |
Creative
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "1220849983_p9290052.jpg",
"advertiser_id": 27,
"creative_type": "plain",
"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
"size": "700x525"
} |
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "240 for show",
"advertiser_id": 27,
"creative_type": "dynamic_creatives",
"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
"size": "240x400",
"snippets": [
169
]
} |
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test_rtbmedia",
"advertiser_id": 27,
"creative_type": "3rd_party_creatives",
"size": "300x250",
"HTML": "<iframe src=\"http://localnetmarketer.com/ads/frame/300x250/722647/ad.html?t=142986782&click=[[CLICK_PREFIX_ENCODED]]\" style=\"border:0;width:300px;height:250px\"></iframe>\n\n",
"ssl_compliant": "false",
"click_tracking": "false"
} |
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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": "240 for showhttp://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge", "advertiser_id": 27, "creative_type": "dynamic_creatives", "site_logo": "cdn.adhigh.net/media/1432213856-logo.png", "size": "240x400native_creatives", "snippets": [ 169 ] } | ||||||
| Блок кода | ||||||
| ||||||
{ "name": "Test_rtbmedialanding_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", "advertiser_idassets": 27, "creative_[ { "type": "3rd_party_creativesvideo", "sizefile": "300x250", "HTML": "<iframe src=\ { "url": "http://localnetmarketercdn.liverail.com/adsadasset4/frame1331/300x250229/7226477969/ad.html?t=142986782&click=[[CLICK_PREFIX_ENCODED]]\" style=\"border:0;width:300px;height:250px\"></iframe>\n\n", "ssl_compliant": "false", "click_tracking": "false" }me.mp4", "file_size" : 1280000, "size": "640x480" }, "duration": 7, "required": true } ] } |
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{ "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'" }, { ://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge/?utm_source=getintent&utm_medium=referral&utm_campaign=3bluemedia_camp1_cv1", "assets": [ { "type": "datavideo", "datathird_typeparty": 1, "value": "Whoa Bella!" }, { { "typewrapperTagUrl": "datahttp://vast.tag/vpaid.xml", "datamime_typetypes": 2 ["application/javascript", "video/mp4"], "valuessl_compliant": "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" false }, "duration": 7, "required": true } ] } |
Creative attributes
| 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"
} |
...
| Блок кода | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "name": "AmberData", "available_to_all": true, "type": "3rdparty", "3rd_party_id{ "name": "AmberDatavi_316104", "available_to_allprice": true1.5, "currency": "USD" } |
Segment attributes
| 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
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "5",
"name": "testDynamicCreativeSnippetJS",
"advertiser_id": "45",
"js": "var s = '<div style=\"padding: 6px 10px 0px 15px;border: 1px solid black;border-radius: 10px;\"'; for(var i=0; i<products.length && i<3; i++) { var product=products[i]; s += '<p style=\"margin-top: 0px;\"><a href=\"' + product['url'] + '\"><img class=\"productImg\" src=\"' + product['picture'] + '\"/><br>' + product['name'] + ' <br> ' + product['price'] + ' руб.</a><br>'; } s+='</div>'; document.getElementById(elementId).innerHTML += s;",
"css": "#creative_[[FUNCTION_NAME]] { border: 0px solid black; font-size: 10pt; font-family: Geneva, Arial, Helvetica, sans-serif; padding: 10px; } #creative_[[FUNCTION_NAME]] .productImg{width:100px;height:80px;}"
} |