...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "21",
"name": "Any advertiser",
"url": "http://advertiser.domain/",
"manage_campaigns_commissions": "true",
"default_agency_commission": "15",
"default_dsp_commission": "35",
"currency": "USD",
"prepayment_mode": "false",
"hide_billingcurrency": "trueUSD",
"credit": 10000,
"max_budget": 4707.27
} |
Advertiser attributes
| Attribute | Required | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
name | yes | string | Advertiser name | ||||||
url | no | string | Advertiser domain | ||||||
default_dsp_commission | yes | float | Default DSP commission for any advertiser campaign | ||||||
default_agency_commission | yes | float | Default agency commission for any advertiser campaign | ||||||
name | yes | currency | no | string | Advertiser currencyname | ||||
hide_billingurl | no | boolean | Activating/hiding financial info in UI | string | Advertiser domain | ||||
currency | no | boolean | Activates managing DSP/Agency commissions at campaign level (UI) | string | Advertiser currency | credit | no | float | Advertiser overspend limit |
Campaign
Browser campaign
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test campaign!",
"advertiser_id": 27,
"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",
"dspprice": "10"3.5
},
"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"
]
},
"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": [": "10",
"IOSweek": "30"
]},
},
"operating_systems": [
"creatives_type": "plain",
"landing_page": "https://...",IOS"
"disabled": true,
]
"commissions": {
},
"agencycreatives_type": 0,
"plain",
"dsplanding_page": "15"https://...",
}"disabled": true,
"for_mobile_device": "true",
"negative_targeting": {
"mobile": {
"application": [
"555717978",
"866990710",
"799442576"
]
}
},
"creatives": [
"6869",
"6870",
"6871",
"6872",
"6873",
"6874",
"6875",
"6876"
]
} |
...
| 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 | no | object | Campaign negative targetings |
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 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 Micro Bidding configuration. See table below for object description. |
...
| 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
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
"financing": {
"type": "max_cpm",
"price": "3",
"dynamic_prices": [
{
"id": 1,
"price": 5,
"features": {
"ssp": "bsw.brx",
"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"
}
}
]
} |
...
| 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) |
...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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;}"
} |