История страницы

Оглавление

Advertiser

...

Блок кода

language	js
title	Example
linenumbers	true

        {
            "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
max_budget	integer	Max budget, available for advertiser
manage_campaigns_commissions	boolean	Activates managing DSP/Agency commissions at campaign level
hide_billing	boolean	Activating/hiding financial info in UI
credit	float	Credit limit
max_budget	float	Monthly budget

Campaign (Display)

			"max_budget": 4707.27
		}

Advertiser attributes

Attribute	Required	Type	Description
`name`	yes	string	Advertiser name
`url`	no	string	Advertiser domain
`currency`	no	string	Advertiser currency

Campaign

Browser campaign

Блок кода

language	js
title	Example
linenumbers	true

{
	"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
	},
	"group_id": 0,
	"targeting": {
		"geo": {
			"countries": [
				"US"
			],
			"regions": [
				"US/FL",
				"US/PA",
				"US/NJ"
			],
			"cities": [
				"Jersey City",
				"Houston"
			],
			"dma_code": [
				"500",
				"502"
			],
			"zip_code

Блок кода

language	js
title	Example
linenumbers	true

{
	"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": [
				"US10010"
			]
		},
			"regionssegments": [
			1009,
			"US/FL"1048,
				"US/PA"1050,
				"US/NJ"1071
			],
			"citiescategories": [
				"Jersey Cityiab2",
				"Houston"
			]iab2-1",
			"dma_code": [iab2-2",
				"500iab2-3",
				"502iab2-12"
			], 
			"zipfrequency_codecapping": [{
			"hour": 4,
			"10010day": 10,
			]"week": 30
		},
		"segmentsweekdays": [
			1009"1",
			1048"2",
			1050"3",
			1071"4",
			]"5",
			"categories6": [,
			"iab27"
		],
		"time": [
			"iab2-1",
			"iab2-2",
			"iab2-3",
			"iab2-124",
		]	"5", 
			"frequency_capping": {6",
			"hour7": 4,
			"day8": 10,
			"week9": 30,
		},
		"weekdays10": [,
			"111",
			"212",
			"313",
			"414",
			"515",
			"616",
			"717",
		],
		"time18": [,
			"119",
			"220",
			"321",
			"422",
			"523",
			"60",
			"7"],
			"8ssps",: [
			"9goog",
			"10bsw.rubicon",
			"11bsw.pubmatic",
			"12"],
			"13",page_language": [
			"14en",
			"15"],
			"16devices",: [
			"17DESKTOP",
			"18SMARTPHONE",
			"19TABLET",
			"20"],
			"21positions",: [
			"22above",
			"23below",
			"0unknown"
		],
		"sspsoperating_systems": [
			"googIOS",
			"bsw.rubiconANDROID",
			"bsw.pubmaticWINDOWS",
		]	"LINUX",
			"page_language": [MACOS",
			"enOTHER",
			"WINDOWS_PHONE"
		],
		"devicesbrowsers": [
			"DESKTOPFIREFOX",
			"SMARTPHONEIE",
			"TABLETEDGE",
		],
		"positionsOPERA": [,
			"aboveYANDEX",
			"belowCHROME",
			"unknownSAFARI",
		],
		"operatingANDROID_systemsBROWSER": [,
			"IOSOTHER",
		]
	"ANDROID"},
			"WINDOWS",
	negative_targeting": {
		"LINUX",domains_lists": [
			"MACOS6",
		]
	"OTHER"},
	"daily_budget": 12,
			"WINDOWSsite_PHONE"
		]id": 42,
		"browserscreatives": [
			"FIREFOX"210,
			"IE"3013,
			"EDGE"3014,
			"OPERA"3015,
			"YANDEX"3016,
			"CHROME"3017,
			"SAFARI"3018,
			"ANDROID_BROWSER"3019,
			"OTHER"3020,
		]3021,
	},
	"daily_budget": 12,
	"site	3022,
		3023,
		3024
	]
}

In-App campaign

Блок кода

language	js

      {
            "name": "In app campaign",
            "advertiser_id": 42"26",
	"creatives": [
		210,
		3013,
		3014,
		3015,
		3016,
		3017,
		3018,
		3019,
		3020,
		3021,
		3022,
		3023,
		3024
	]
}

Campaign (In-App)

Блок кода

language	js

      {            "starts": "2015-01-02 21:00:00",
            "ends": "2015-01-11 20:59:59",
            "group_id": "181",
            "namecurrency": "In app campaignUSD",
            "advertiser_idbudget": "263000",
            "startsfinancing": "2015-01-02 21:00:00",
 {
                "endstype": "2015-01-11 20:59:59max_cpm",
                "group_idprice": "1813.25",
            "currency": "USD"},
            "budgettargeting": "3000",{
                "financingdevices": {[
                   "type": "max_cpmSMARTPHONE",
                "price": "3.25"
   ],
	         },
            "targetinggeo": {
                    "devicesregions": [
                        "SMARTPHONE77",
                ],
	        "78"
         "geo": {
          ]
          "regions": [
     },
                   "77","mobile": {
					"application_category": [
                        "78Business",
                    ]
    "IT&Gadgets",
            },
                "mobile": {
					"application_category": [
Education&Science",
                        "BusinessReference",
                    ]
    "IT&Gadgets",
            },
               "Education&Science", "frequency_capping": {
                        "Reference""day": "10",
                    ] "week": "30"
                },
                "frequencyoperating_cappingsystems": {[
                    "day": "10",IOS"
                ]
    "week": "30"
       },
         },
   "creatives_type": "plain",
            "operatinglanding_systemspage": [
"https://...",
            "disabled": true,
            "for_mobile_device": "IOStrue",
            "negative_targeting": {
    ]
             },"mobile": {
            "creatives_type        "application": "plain",[
            "landing_page": "https://...",
            "disabled555717978": true,
            "commissions": {
            "866990710",
      "agency": 0,
                "dsp": "15799442576"
            },
        ]
    "for_mobile_device": "true",
            "negative_targeting": {}
            },
    "mobile": {
                    "application"creatives": [
                "6869",
        "555717978",
        "6870",
                "8669907106871",
                        "7994425766872",
                    ]"6873",
                }"6874",
            },
            "creatives": ["6875",
                "68696876",
            ]
    "6870",
    }

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
`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
`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	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

Блок кода

language	js
title	Dynamic Financing JSON Example
linenumbers	true

"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"
				}
			}
		]
	}

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
`geo.countries`	array of strings	Country 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
`segments_all`	array of strings	User segment targeting - all at once
`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 integers	Weekday targeting: 1(Monday)..7(Sunday)
`time`	array of integers	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"
`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

Блок кода

language	js
title	Example
linenumbers	true

       "6871",
                "6872",
                "6873",{
               "id": "68741",
               "name": "6875Test",
                "6876"
"advertiser_id": "2",
             ]"budget_limit": "100000.00"
        }

Campaign group attributes

Attribute	Required	Type

DescriptionnameyesstringCampaign name

currency

yesstringISO-4217 currency codestartsyes

YYYY-MM-DD HH:MM:SS formatted string

Campaign start time (UTC)endsyes

YYYY-MM-DD HH:MM:SS formatted string

Campaign end time (UTC)for_mobile_deviceyesbooleanIs in-app campaign

group_id

nointegerCampaign groupId in case campaign is sharing budget with other campaignscreative_typeyesstring

Campaign creative type, enum value

"plain"/"3rd_party_creatives"/"dynamic_creatives""video"/"native_creatives"

budget

yesfloatCampaign budget

disabled

yesbooleanActivates/stops campaign

financing

yesobjectCampaign pricing model

commissions

yesobjectDSP/Agency commissions in case commissions are calculated on RTBSuite sidelanding_pageyesstringDeclared campaign landing page URL

daily_budget

nofloatCampaign budget limitsite_idnointegerCampaign related site objectcreativesyesarray of integersCampaign creativestargetingyesobjectCampaign positive targetingsnegativenoobjectCampaign 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 object

Блок кода

language	js
title	Example
linenumbers	true

        {
            "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

Блок кода

language	js
title	Example
linenumbers	true

{
	"name": "Test list",
	"advertiser_id": 27,
	"domains": [
		"yandex.ru",
		"google.com",
		"yahoo.com"
	]
}

Creative

Блок кода

language	js
title	Standard Creative Example
linenumbers	true

{
	"name": "1220849983_p9290052.jpg",
	"advertiser_id": 27,
	"creative_type": "plain",
	"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
	"size": "700x525"
}

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

Блок кода

language	js
title	Example
linenumbers	true

{
	"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

{
	"name": "1220849983_p9290052.jpg",
	"advertiser_id": 27,
	"creative_type": "plain",
	"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
	"size": "700x525"
}

Блок кода

language	js
title	Dynamic Creative Example
linenumbers	true

{
	"name": "240 for show",
	"advertiser_id": 27,
	"creative_type": "dynamic_creatives",
	"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
	"size": "240x400",
	"snippets": [
		169
	]
}

Блок кода

language	js
title	Third-party Creative Example
linenumbers	true

{
	"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"
}

Блок кода

language	js
title	Native Creative Example
linenumbers	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'"
		},
		{
			"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

Блок кода

language	js
title	Native Video Plain Example
linenumbers	true

 {
	"name": "http://whoabella.com/whoabella-connected-s1e16-with-change-comes-challenge

Блок кода

language	js
title	Dynamic Creative Example
linenumbers	true

{
	"name": "240 for show",
	"advertiser_id": 27,
	"creative_type": "dynamic_creatives",
	"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
	"size": "240x400"native_creatives",
	"snippets": [
		169
	]
}

Блок кода

language	js
title	Third-party Creative Example
linenumbers	true

{
	"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
      }
	]
}

Блок кода

language	js
title	Native Creative Third Party Video Example
linenumbers	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": "imgvideo",
			"url": "nm.contextweb.com/media/1434570383-connected_cast.jpg",        	"third_party": {
				"image_typewrapperTagUrl": 3,
			"size": "300x260"
		},
		{
"http://vast.tag/vpaid.xml",
				"typemime_types": ["application/javascript", "titlevideo/mp4"],
				"textssl_compliant": "Check Out Latest Episode Of 'Connected'"false
			},
		{
			"type        	"duration": "data"7,
		        	"data_typerequired": 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"
		}
	]
} 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"
`landing_page`	no	string	Landing page URL (with macros)
`assets`	no	array of objects	Native creative assets
`asset.type`	yes	string	Asset type, enum value: "img","title","data","video"
`asset.data_type`	yes	integer	IAB data asset type

Site object

Блок кода

language	js
title	Example
linenumbers	true

{
	"name": "http://test.com",
	"advertiser_id": 27,
	"click_control": "false",
	"feed_url": "http://names.ru/bitrix/catalog_export/rtb.xml"
}

...

Блок кода

language	js
title	Third-party Segment Example
linenumbers	true	true

{
	"name": "AmberData",
	"available_to_all": true,
	"type": "3rdparty",
	"3rd_party_id{
	"name": "AmberDatavi_316104",
	"available_to_allprice": true1.5,
	"typecurrency": "3rdparty",
	"3rd_party_id": "vi_316104",
	"price": 1.5,
	"currency": "USD"
}"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"
`3rd_party_id`	no	string	3rd party segment Id
`price`	no	float	Segment price (CPM)
`currency`	no	string	Segment currency
`terms`	no	object	Segment rules

Snippet

Блок кода

language	js
title	Example
linenumbers	true

        {
            "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;}"
        }

chromechrome

Дерево страниц

Сравнение версий

Старая версия 30

Новая версия Текущий

Ключ

Advertiser

Campaign (Display)

Campaign

Browser campaign

In-App campaign

Campaign (In-App)

Campaign attributes

Campaign Financing

Campaign Dynamic Financing

Example

Campaign targetings

Campaigns group

Campaign targetings

Campaigns group object

Domains list

Creative

Domains list

Creative

Native Video Examples

Site object

Snippet