-
Создана пользователем
Неизвестный пользователь (sergey). Последнее обновление: дек. 15, 2015
Время чтения: 4 мин.
Advertiser
Example
{
"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
| Attribute | Type | Description |
|---|---|---|
| name | string | Advertiser name |
| url | string | Advertiser domain |
default_dsp_commission | float | Default DSP commission for any advertiser campaign |
| currency | string | Advertiser currency |
| prepayment_mode | boolean | Advertiser payment mode |
| max_budget | integer | Max budget, available for advertiser |
hide_billing | boolean | Activating/hiding financial info in UI |
manage_campaigns_commissions | boolean | Activates managing DSP/Agency commissions at campaign level (UI) |
credit | float | Credit limit |
max_budget | float | Monthly budget |
Campaign
Browser campaign
Example
{
"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
},
"commissions": {
"agency": "0",
"dsp": "10"
},
"group_id": 0,
"targeting": {
"geo": {
"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"
]
},
"daily_budget": 12,
"site_id": 42,
"creatives": [
210,
3013,
3014,
3015,
3016,
3017,
3018,
3019,
3020,
3021,
3022,
3023,
3024
]
}
In-App campaign
{
"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,
"commissions": {
"agency": 0,
"dsp": "15"
},
"for_mobile_device": "true",
"negative_targeting": {
"mobile": {
"application": [
"555717978",
"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 | yes | boolean | Is in-app campaign |
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 | yes | boolean | Activates/stops campaign |
financing | yes | object | Campaign pricing model |
commissions | yes | object | DSP/Agency commissions in case commissions are calculated on RTBSuite side |
| 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 | no | object | Campaign negative targetings |
Campaign targetings
Campaign can have both positive and negative targetings, 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 integer | Weekday targeting: 1(Monday)..7(Sunday) |
time | array of integer | 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" |
Campaigns group
Example
{
"id": "1",
"name": "Test",
"advertiser_id": "2",
"budget_limit": "100000.00"
}
Campaign group attributes
| Attribute | Type | Description |
|---|---|---|
| budget_limit | float | Total budget limit for the group of campaigns |
Domains list
Example
{
"name": "Test list",
"advertiser_id": 27,
"domains": [
"yandex.ru",
"google.com",
"yahoo.com"
]
}
Creative
Standard Creative Example
{
"name": "1220849983_p9290052.jpg",
"advertiser_id": 27,
"creative_type": "plain",
"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
"size": "700x525"
}
Dynamic Creative Example
{
"name": "240 for show",
"advertiser_id": 27,
"creative_type": "dynamic_creatives",
"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
"size": "240x400",
"snippets": [
169
]
}
Third-party Creative Example
{
"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"
}
Native Creative Example
{
"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"
}
]
}
Site object
Example
{
"name": "http://test.com",
"advertiser_id": 27,
"click_control": "false",
"feed_url": "http://names.ru/bitrix/catalog_export/rtb.xml"
}
Segment
Standard Segment Example
{
"name": "Test",
"advertiser_id": 27,
"available_to_all": false,
"type": "standard",
"terms": [
{
"type": "site_visitor",
"values": [
198
],
"times": 1,
"days": 30,
"negative": false
}
]
}
Third-party Segment Example
{
"name": "AmberData",
"available_to_all": true,
"type": "3rdparty",
"3rd_party_id": "vi_316104",
"price": 1.5,
"currency": "USD"
}
Snippet
Example
{
"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;}"
}