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

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Оглавление

Advertiser

...

Блок кода
languagejs
titleExample
linenumberstrue
        {
            "id": "21",
            "name": "Any advertiser",
            "url": "http://advertiser.domain/",
            "timezone": "Europe/Moscow",
            "default_dsp_commission": "35",
            "currency": "USD",
            "prepayment_mode": "false",
            "hide_billing": "true",
            "credit": 10000,
			"max_budget": 4707.27

        }
AttributeDescriptionTypeValuesDefault value
max_budgetMax budget, available for advertiserinteger0..0
manage_campaigns_commissions
Activates managing DSP/Agency commissions at campaign levelbooleanfalse, true 
hide_billing
Activating/hiding financial info in UIbooleanfalse, true 

Campaign (Display)

			"max_budget": 4707.27
		}

Advertiser attributes

AttributeRequiredTypeDescription
nameyesstringAdvertiser name
urlnostringAdvertiser domain
currencynostringAdvertiser currency

Campaign

Browser campaign

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "Test campaign!",
	"advertiser_id": 27,
	"test-fieldstarts": "test",
	"starts": "2013-11-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,
	"was_enabled": 1421915484,
	"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"
		]
	},
	"dailynegative_budgettargeting": 12,{
		"sitedomains_idlists": 42,[
			"creatives":6"
		]
	},
	"daily_budget": 12,
	"site_id": 42,
	"creatives": [
		210,
		3013,
		3014,
		3015,
		3016,
		3017,
		3018,
		3019,
		3020,
		3021,
		3022,
		3023,
		3024
	]
}

...

In-App

...

campaign

Блок кода
languagejs
      {
            "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://...",
            "was_enableddisabled": 1420453290true,
            "disabledfor_mobile_device": "true",
            "commissionsnegative_targeting": {
                "agencymobile": 0,{
                    "dspapplication": "15"[
            },
            "for_mobile_device": "true555717978",
            "negative_targeting": {
           "866990710",
     "mobile": {
                    "application799442576": [
                    ]
    "555717978",
            }
            "866990710"},
            "creatives": [
            "799442576"
                    ]"6869",
                }
     "6870",
       },
            "creatives6871": [,
                "68696872",
                "68706873",
                "68716874",
                "68726875",
                "68736876",
                "6874",]
                "6875",
                "6876"
            ]
        }

Campaigns group object

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "group name",
	"advertiser_id": 27,
	"budget_limit": 55000
}

Domains list

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "Test list",
	"advertiser_id": 27,
	"domains": [
		"yandex.ru",
		"google.com",
		"yahoo.com"
	]
}

Creative

Блок кода
languagejs
titleStandard Creative Example
linenumberstrue
{
	"name": "1220849983_p9290052.jpg",
	"advertiser_id": 27,
	"creative_type": "plain",
	"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
	"size": "700x525",
	"alternative_creative_id": "false"
}
Блок кода
languagejs
titleDynamic Creative Example
linenumberstrue
{
	"name": "240 for show",
	"advertiser_id": 27,
	"creative_type": "dynamic_creatives",
	"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
	"size": "240x400",
	"snippets": [
		169
	]
}
Блок кода
languagejs
titleThird-party Creative Example
linenumberstrue
{
	"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"
}
Блок кода
languagejs
titleNative Creative Example
linenumberstrue
{
	"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

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "http://test.com",
	"advertiser_id": 27,
	"click_control": "false",
	"feed_url": "http://names.ru/bitrix/catalog_export/rtb.xml"
}

Segment

Блок кода
languagejs
titleStandard Segment Example
linenumberstrue
{
	"name": "Test",
	"advertiser_id": 27,
	"available_to_all": false,
	"type": "standard",
	"terms": [
		{
			"type": "site_visitor",
			"values": [
				198
			],
			"times": 1,
			"days": 30,
			"negative": false
		}
	]
}
Блок кода
languagejs
titleThird-party Segment Example
linenumberstrue
{
	"name": "AmberData/Продукты питания/Молочные продукты",
	"available_to_all": true,
	"type": "3rdparty",
	"3rd_party_id": "vi_316104",
	"price": 25,
	"currency": "RUB"
}

Snippet 

...

languagejs
titleExample
linenumberstrue

...

}


Campaign attributes

AttributeRequiredTypeDescription
nameyesstringCampaign name
currencyyesstringISO-4217 currency code
startsyes
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_devicenobooleanIs in-app campaign (default false)
group_idnointegerCampaign groupId in case campaign is sharing budget with other campaigns
creative_typeyesstring

Campaign creative type, enum value

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

budgetyesfloatCampaign budget
disablednobooleanActivates/stops campaign (default false)
financingyesobjectCampaign pricing model
landing_pageyesstringDeclared campaign landing page URL
daily_budget
nofloatCampaign budget limit
site_idnointegerCampaign related site object
creativesyesarray of integersCampaign creatives
targetingyesobjectCampaign positive targetings
negative_targetingnoobjectCampaign negative targetings
fp_switch
nostring

Fillrate predictor

"on" - enabled

"off" - disabled

"inherit" - inherit fillrate predictor state from advertiser

budget_pacing
nostringCampaign budget pacing. Values: "DAILY", "CAMPAIGN" (default "CAMPAIGN").


Campaign Financing

 

AttributeRequiredTypeDescription
typeyesstringType of financing: fixed_cpm, max_cpm, target_cpc, target_cpmv, fixed_cpc, target_cpa
priceyesstringPrice value.
dynamic_pricesnoarray of objectMicro Bidding configuration. See table below for object description.


Campaign Dynamic Financing

AttributeRequiredTypeDescription
idyesnumberUnique ID
priceyesnumberPrice for the current set of features.
featuresyesobjectFeatures for the current price
features.sspnostringSSP name feature. Example: "adx"
features.browsernostringBrowser name feature. Values: FIREFOX, IE, EDGE, OPERA, YANDEX, ANDROID_BROWSER, CHROME, SAFARI, FACEBOOK_APP
features.devicenostringDevice type feature. Values: UNKNOWN, SMARTPHONE, TABLET, DESKTOP, SMART_TV, GAME_CONSOLE
features.domainnostringDomain feature. Example: "*.google.com", "facebook.com"
features.app_idnostringApplication ID feature. Example: "com.instagram.android", "389801252"
features.sizenostringCreative Size feature. Example: "320x240"
features.osnostringOperating System feature. IOS, ANDROID, WINDOWS, LINUX, MACOS, OTHER, WINDOWS_PHONE, BLACKBERRY
features.segment_idnonumberSegment id feature. Example: 16951

Example

Блок кода
languagejs
titleDynamic Financing JSON Example
linenumberstrue
"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:


TargetingTypeDescription
geoobjectPlaceholder for geo targetings

geo.countries

array of stringsCountry codes

geo.regions

array of stringsCountry region codes

geo.cities

array of stringsCities

geo.dma_code

array of stringsDMA codes

geo.zip_code

array of stringsZip codes
segmentsarray of stringsUser segment targeting
segments_allarray of stringsUser segment targeting - all at once
categoriesarray of stringsIAB content category targeting
frequency_capping
objectFrequency capping
    frequency_capping.week
integerImpressions per week (optional)
    frequency_capping.day
integerImpressions per day (optional)
    frequency_capping.hour
integerImpressions per hour (optional)
weekdays
array of integersWeekday targeting: 1(Monday)..7(Sunday)
time
array of integersHour targeting: 0..23
sspsarray of stringsSSP targeting
page_languagearray of stringsBrowser language
devices
array of strings

Device targeting: "DESKTOP","SMARTPHONE","TABLET"

positions
array of stringsPosition: "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"

domainsarray of stringsExcluded domains (usually for negative targeting only)
domains_listsarray of integersDomain 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

Блок кода
languagejs
titleExample
linenumberstrue
        {
            "id": "1",
            "name": "Test",
            "advertiser_id": "2",
            "budget_limit": "100000.00"
        }

Campaign group attributes

AttributeRequiredTypeDescription
advertiser_idyesintegerAdvertiser Id
nameyesstringAdvertiser name
budget_limityesfloatBudget limit for the group of campaigns

Domains list

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "Test list",
	"advertiser_id": 27,
	"domains": [
		"yandex.ru",
		"google.com",
		"yahoo.com"
	]
}

Domain list  attributes

AttributeRequiredTypeDescription
nameyesstringDomain list name
domainsyesarray of stringsDomains

Creative

Блок кода
languagejs
titleStandard Creative Example
linenumberstrue
{
	"name": "1220849983_p9290052.jpg",
	"advertiser_id": 27,
	"creative_type": "plain",
	"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
	"size": "700x525"
}
Блок кода
languagejs
titleDynamic Creative Example
linenumberstrue
{
	"name": "240 for show",
	"advertiser_id": 27,
	"creative_type": "dynamic_creatives",
	"site_logo": "cdn.adhigh.net/media/1432213856-logo.png",
	"size": "240x400",
	"snippets": [
		169
	]
}
Блок кода
languagejs
titleThird-party Creative Example
linenumberstrue
{
	"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"
}
Блок кода
languagejs
titleNative Creative Example
linenumberstrue
{
	"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


Блок кода
languagejs
titleNative Video Plain Example
linenumberstrue
 {
	"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
      }
	]
}

 

Блок кода
languagejs
titleNative Third Party Video Example
linenumberstrue
 {
	"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",
        	"third_party": {
				"wrapperTagUrl": "http://vast.tag/vpaid.xml",
				"mime_types": ["application/javascript", "video/mp4"],
				"ssl_compliant": false
			},
        	"duration": 7,
        	"required": true
      }
	]
}


Creative  attributes

AttributeRequiredTypeDescription
nameyesstringCreative name
advertiser_idyesintegerAdvertiser Id
creative_typeyesstring

Creative type, enum value:

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

landing_page
nostringLanding page URL (with macros)
assetsnoarray of objectsNative creative assets

asset.type

yesstring

Asset type, enum value:

"img","title","data","video"

asset.data_type

yesinteger

IAB data asset type


Site object

Блок кода
languagejs
titleExample
linenumberstrue
{
	"name": "http://test.com",
	"advertiser_id": 27,
	"click_control": "false",
	"feed_url": "http://names.ru/bitrix/catalog_export/rtb.xml"
}

Segment

Блок кода
languagejs
titleStandard Segment Example
linenumberstrue
{
	"name": "Test",
	"advertiser_id": 27,
	"available_to_all": false,
	"type": "standard",
	"terms": [
		{
			"type": "site_visitor",
			"values": [
				198
			],
			"times": 1,
			"days": 30,
			"negative": false
		}
	]
}
Блок кода
languagejs
titleThird-party Segment Example
linenumberstrue
{
	"name": "AmberData",
	"available_to_all": true,
	"type": "3rdparty",
	"3rd_party_id": "vi_316104",
	"price": 1.5,
	"currency": "USD"
}

Segment  attributes

AttributeRequiredTypeDescription
nameyesstringCreative name
advertiser_idnointegerAdvertiser Id
typeyesstring

Segment type, enum value:

"standard"/"3rd_party"

3rd_party_id
nostring3rd party segment Id
pricenofloatSegment price (CPM)
currency


nostringSegment currency
termsnoobjectSegment rules

Snippet 

Блок кода
languagejs
titleExample
linenumberstrue
        {
            "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;}"
        }