Запрос из RTB-хоста
Предложение участвовать в аукционе передается методом POST в формате JSON (Content-Type: application/json).
В теле запроса содержится объект Bid Request. Его параметры характеризуют сайт, конечное устройство, потребителя. Эти характеристики помогают DSP подобрать рекламу и ставку.
{ /* obj:Bid Request object */
"id": (string),
"cur":[(string)],
"imp":[
{ /* obj:Impression object */
"id": (string),
"banner": {
/* obj:Banner object */
"w": (int),
"h": (int)
},
"banners":[
{ /* obj:Banner object */
"w":(int),
"h":(int)
},
{
...
}
],
"bidfloor": (int),
"bidfloorcur": (string),
"secure": (int)
}
],
"site": {
/* obj:Site object */
"id": (string),
"domain": (string),
"referer": (string),
"rereferer": (string),
"referer_hash": (string),
"skiptoken": (string)
},
"device": {
/* obj:Device object */
"ua": (string),
"ip": (string),
"geo": {
/* obj:Geo object */
"yandex_reg_id": (int),
"yandex_orig_reg_id": (string),
"country": (string),
"region": (string),
"city": (string)
},
"userdata": (string)
}
}
Параметр | Описание | Обязат. |
Bid Request object | ||
---|---|---|
id | Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
imp | Массив объектов Impression, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
site | Информация о сайте в объекте Site. | да |
device | Информация о конечном устройстве в объекте Device. | да |
Impression object | ||
id | Идентификатор рекламного блока на HTML-странице. | да |
banner | Объект Banner с размерами рекламного блока по умолчанию. | да |
banners | Массив объектов Banner со списком допустимых размеров рекламного блока. | да |
bidfloor | Минимальная стоимость одного показа для текущего аукциона. Стоимость указывается в миллионных долях валюты. | нет |
bidfloorcur | Валюта стоимости. В текущей реализации используется значение RUB. | нет |
secure | Тип соединения. Возможные варианты:
| нет |
Banner object | ||
w | Ширина блока в пикселях. | да |
h | Высота блока в пикселях. | да |
Site object | ||
id | Идентификатор сайта. | да |
domain | Домен сайта. | да |
referer | Значение HTTP-заголовка Referer из запроса конечного устройства к RTB-хосту. | нет |
rereferer | Значение HTTP-заголовка Referer из запроса конечного устройства к сайту. | нет |
referer_hash | Зашифрованный URL страницы. | нет |
skiptoken | Содержит информацию о баннерах, которые уже отрисованы на данной странице. | нет |
Device object | ||
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ip | IP-адрес конечного устройства. | да |
geo | Объект Geo с описанием местоположения конечного устройства. | да |
userdata | Данные, связанные с потребителем рекламы (не более 22 символов). Формат данных определяет DSP (см. Маркировка пользователей). | нет |
Geo object | ||
yandex_reg_id | Город, выбранный потребителем рекламы в качестве основного региона. Примечание. Пользователи Яндекса могут выбирать регион на странице https://yandex.ru/tune/geo или через всплывающее сообщение об уточнении города. | нет |
yandex_orig_reg_id | Регион, в котором фактически находится конечное устройство. Определяется автоматически по IP-адресу устройства. | нет |
country | Геокод страны по классификации ISO-3166-1 Alpha-2. | да |
region | Геокод региона по классификации ISO 3166-2. | да |
city | Код города согласно коду Организации Объединенных Наций для торговли и транспортных пунктов. | да |
Параметр | Описание | Обязат. |
Bid Request object | ||
---|---|---|
id | Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
imp | Массив объектов Impression, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
site | Информация о сайте в объекте Site. | да |
device | Информация о конечном устройстве в объекте Device. | да |
Impression object | ||
id | Идентификатор рекламного блока на HTML-странице. | да |
banner | Объект Banner с размерами рекламного блока по умолчанию. | да |
banners | Массив объектов Banner со списком допустимых размеров рекламного блока. | да |
bidfloor | Минимальная стоимость одного показа для текущего аукциона. Стоимость указывается в миллионных долях валюты. | нет |
bidfloorcur | Валюта стоимости. В текущей реализации используется значение RUB. | нет |
secure | Тип соединения. Возможные варианты:
| нет |
Banner object | ||
w | Ширина блока в пикселях. | да |
h | Высота блока в пикселях. | да |
Site object | ||
id | Идентификатор сайта. | да |
domain | Домен сайта. | да |
referer | Значение HTTP-заголовка Referer из запроса конечного устройства к RTB-хосту. | нет |
rereferer | Значение HTTP-заголовка Referer из запроса конечного устройства к сайту. | нет |
referer_hash | Зашифрованный URL страницы. | нет |
skiptoken | Содержит информацию о баннерах, которые уже отрисованы на данной странице. | нет |
Device object | ||
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ip | IP-адрес конечного устройства. | да |
geo | Объект Geo с описанием местоположения конечного устройства. | да |
userdata | Данные, связанные с потребителем рекламы (не более 22 символов). Формат данных определяет DSP (см. Маркировка пользователей). | нет |
Geo object | ||
yandex_reg_id | Город, выбранный потребителем рекламы в качестве основного региона. Примечание. Пользователи Яндекса могут выбирать регион на странице https://yandex.ru/tune/geo или через всплывающее сообщение об уточнении города. | нет |
yandex_orig_reg_id | Регион, в котором фактически находится конечное устройство. Определяется автоматически по IP-адресу устройства. | нет |
country | Геокод страны по классификации ISO-3166-1 Alpha-2. | да |
region | Геокод региона по классификации ISO 3166-2. | да |
city | Код города согласно коду Организации Объединенных Наций для торговли и транспортных пунктов. | да |
Пример запроса
{
"id" : "5916234431280742401",
"imp" : [
{
"id" : "2",
"banner" : {
"w" : 240,
"h" : 400
},
"bidfloor" : 1000,
"bidfloorcur" : "RUB",
"secure" : 0
}
],
"site" : {
"id" : "118547",
"domain" : "yandex.ru",
"referer" : "http:\/\/partner2.yandex.ru\/",
"referer_hash" : "3291557941",
"skiptoken" : ""
},
"device" : {
"ua" : "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_11) AppleWebKit\/601.1.56 (KHTML, like Gecko) Version\/9.0 Safari\/601.1.56",
"ip" : "192.168.1.1",
"userdata" : "",
"geo": {
"country" : "RU",
"region" : "RU-MOW",
"city" : "RU MOW"
}
},
"cur" : ["RUB","USD","EUR","TRY","UAH","KZT","CHF"]
}