...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "21",
"name": "Any advertiser",
"url": "http://advertiser.domain/",
"currency": "USD",
"max_budget": 4707.27
} |
Атрибуты рекламодателя
| Атрибут | Обязательный | Тип | Описание |
|---|---|---|---|
name | yes | строчный | Название рекламодателя |
url | no | строчный | Домен рекламодателя |
currency | no | строчный | Валюта рекламодателя |
Кампания
Браузерная кампания
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test campaign!",
"advertiser_id": 27,
"starts": "2013-11-12 00:00:00",
"ends": "2014-03-09 22:59:59",
"currency": "USD",
"creatives_typefor_mobile_device": false,
"for_native_ads": false,
"for_video_ads": "plain"false,
"for_dooh": false,
"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": [
"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,
"for_mobile_device": "true",
"negative_targeting": {
"mobile": {
"application": [
"555717978",
"866990710",
"799442576"
]
}
},
"creatives": [
"6869",
"6870",
"6871",
"6872",
"6873",
"6874",
"6875",
"6876"
]
} |
Атрибуты кампании
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
name | да | строчный | Название кампании |
currency | да | строчный | Код валюты ISO-4217 |
starts | да | YYYY-MM-DD HH:MM:SS строчный формат | Время старта кампании (UTC) |
ends | да | YYYY-MM-DD HH:MM:SS строчный формат | Время окончания кампании (UTC) |
for_mobile_device |
| да | логический | если кампания in-app | |
group_id | нет | целое число | Группа кампаний |
| for_video_ |
| ads | да | логический |
если кампания видео | |||
| for_native_ads | да | логический | если кампания native |
| for_dooh | да | логический | если кампания dooh |
budget | да | числовой | Бюджет кампании |
disabled | нет | логический | Активирует / останавливает кампанию (по умолчанию false) |
financing | да | объект | ценовая модель кампании |
landing_page | да | строчный | URL целевой страницы кампании |
| нет | числовой | Бюджетный лимит кампании |
site_id | нет | целое число | ID сайта, связанного с кампанией |
creatives | да | множество целых чисел | Креативы |
targeting | да | объект | Позитивные таргетинги в кампании |
negative_targeting | нет | объект | Негативные таргетинги в кампании |
fp_switch | нет | строчный | Предиктор Fillrate "on" - включен "off" - выключен "inherit" - состояние зависит от рекламодателя |
budget_pacing | нет | строчный | Распределение бюджета кампании. Значения: "DAILY", "CAMPAIGN" (по умолчанию "CAMPAIGN"). |
Бюджетирование кампании
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
| type | да | строчный | Тип ставки: fixed_cpm, max_cpm, target_cpc, target_cpmv, fixed_cpc, target_cpa |
| price | да | строчный | Цена |
| dynamic_prices | нет | массив объектов | Конфигурация микробиддинга |
Динамическое бюджетирование кампании
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
| id | да | числовой | Уникальный ID |
| price | да | числовой | Цена на текущий набор функций. |
| features | да | объект | Функции за текущую цену |
| features.ssp | нет | строчный | Название SSP. Пример: "adx" |
| features.browser | нет | строчный | Название браузера. Примеры:: FIREFOX, IE, EDGE, OPERA, YANDEX, ANDROID_BROWSER, CHROME, SAFARI, FACEBOOK_APP |
| features.device | нет | строчный | Тип устройства. Значения: UNKNOWN, SMARTPHONE, TABLET, DESKTOP, SMART_TV, GAME_CONSOLE |
| features.domain | нет | строчный | Домен. Пример: "*.google.com", "facebook.com" |
| features.app_id | нет | строчный | ID приложения. Пример: "com.instagram.android", "389801252" |
| features.size | нет | строчный | Размер креатива. Пример: "320x240" |
| features.os | нет | строчный | Oперационные системы. IOS, ANDROID, WINDOWS, LINUX, MACOS, OTHER, WINDOWS_PHONE, BLACKBERRY |
| features.segment_id | нет | числовой | ID сегментов. Пример: 16951 |
Пример
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
"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"
}
}
]
} |
...
Кампания может иметь как позитивные, так и негативные таргетинги. Getintent поддерживает следующие виды таргетингов:
| Таргетинг | Тип | Описание |
|---|---|---|
geo | объект | Заполнитель для геотаргетинга |
| массив строк | Страна |
| массив строк | регион |
| массив строк | города |
| массив строк | DMA код |
| массив строк | почтовый индекс |
segments | массив строк | сегменты |
segments_all | массив строк | пользователь должен быть во всех сегментах сразу |
categories | массив строк | IAB категория контента |
| объект | Ограничение частоты |
| целое число | Показы в неделю |
| целое число | Показы в день |
| целое число | Показы в час |
| массив строк | Таргетинг по дням недели: 1 (понедельник) .. 7 (воскресенье) |
| массив строк | Часовой таргетинг: 0..23 |
ssps | массив строк | SSP тагетинг |
page_language | массив строк | язык страниц в браузере |
| массив строк | Таргетинг по типам устройств: "DESKTOP","SMARTPHONE","TABLET" |
| массив строк | Расположение: "above","below","unknown" |
| массив строк | Таргетинг по операционным системам: "IOS","ANDROID","WINDOWS","LINUX","MACOS","OTHER","WINDOWS_PHONE" |
| массив строк | Браузерный таргетинг: "FIREFOX","IE","EDGE","OPERA","YANDEX","CHROME","SAFARI","ANDROID_BROWSER","OTHER" |
domains | массив строк | Исключенные домены (обычно только для отрицательного таргетинга) |
domains_lists | массив строк | Таргетинг по ID списка доменов |
Таргетинг по спискам доменов и просто по доменам должны применяться раздельно.
...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"id": "1",
"name": "Test",
"advertiser_id": "2",
"budget_limit": "100000.00"
} |
Атрибуты группы кампаний
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
advertiser_id | да | целое число | Id рекламодателя |
name | да | строчный | Название рекламодателя |
budget_limit | да | числовой | Бюджетное ограничение для группы кампаний |
Список доменов
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "Test list",
"advertiser_id": 27,
"domains": [
"yandex.ru",
"google.com",
"yahoo.com"
]
} |
Атрибуты списка доменов
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
name | да | строчный | Наименование списка доменов |
domains | да | строчный массив | Домены |
Креативы
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"name": "1220849983_p9290052.jpg",
"advertiser_id": 27,
"creative_type": "plain",
"url": "cdn.adhigh.net/media/1424168069-1220849983_p9290052.jpg",
"size": "700x525"
} |
...
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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
}
]
} |
Атрибуты креативов
| Атрибут | Обязательно | Тип | Описание |
|---|---|---|---|
name | да | строчный | Наименование креатива |
advertiser_id | да | числовой | Id рекламодателя |
creative_type | да | строчный | Тип креатива: "plain"/"3rd_party_creatives"/"dynamic_creatives""video"/"native_creatives" |
| нет | строчный | Целевая страница (с макросом) |
assets | нет | массив объектов | Тип креатива |
| да | строчный | значения: "img","title","data","video" |
| да | числовой | Тип креатива по IAB |
Сайт
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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": "vi_316104",
"price": 1.5,
"currency": "USD"
} |
Атрибуты сегментов
| Атрибуты | Обязтельно | Тип | Описание |
|---|---|---|---|
name | да | строчный | Название креатива |
advertiser_id | нет | числовой | Id рекламодателя |
type | да | строчный | Тип сегмента: "standard"/"3rd_party" |
| нет | строчный | ID 3rd party сегмента |
price | нет | целое число | Стоимость сегмента (СРМ) |
currency | нет | строчный | Валюта сегмента |
terms | нет | объект | Правило сегмента |
Сниппет
| Блок кода | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"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;}"
} |
...