Запрос из OpenRTB-хоста
Предложение участвовать в аукционе передается методом POST в формате JSON (Content-Type: application/json).
Тело запроса
В теле запроса содержится объект Bid Request
. Его параметры характеризуют приложение, конечное устройство, потребителя. Эти характеристики помогают DSP подобрать рекламу и ставку.
{
"source": {
"fd": "(int)",
"sourcetype": "(int)",
"tid": "(string)",
"ext": {
"schain": {
"complete": "(int)",
"nodes": [
{
"asi": "(string)",
"sid": "(string)",
"hp": "(int)",
"rid": "(string)"
}
],
"ver": "(string)"
}
}
},
"id": "(string)",
"user": {
"buyeruid": "(string)",
"id": "(string)",
"ext": {
"consent": "(string)"
}
},
"imp": [
{
"bidfloor": "(float)",
"bidfloorcur": "(string)",
"displaymanager": "(string)",
"id": "(string)",
"instl": "(int)",
"ext": {
"unmoderated": "(int)",
"skadn": {
"version": "(string)",
"versions": ["(array of strings)"],
"sourceapp": "(int)",
"skadnetids": [
"(array of strings)"
],
"fidelities": [
"(array of strings)"
]
}
},
"secure": "(int)",
"tagid": "(string)",
"native": {
"request": "{ \"native\": {\"ver\": \"(string)\",\"aurlsupport\": (int),\"privacy\": (int),\"plcmtcnt\": (int),\"assets\": [{\"required\":(int),\"title\": {\"len\": (int)},\"id\": (int)}, {\"required\": (int),\"img\": {\"wmin\": (int),\"type\": (int),\"hmin\": (int)},\"id\": (int)},{\"required\": (int),\"data\": {\"len\": (int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"data\": {\"len\": (int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"data\":{\"len\":(int),\"type\": (int)},\"id\": (int)},{\"required\": (int),\"img\":{\"wmin\": (int),\"type\": (int),\"hmin\": (int)},\"id\": (int)}],\"eventtrackers\":[{\"methods\":[(int)],\"event\": (int)}]}}",
"ver": "(string)"
},
"displaymanagerver": "(string)",
"clickbrowser": "(int)"
}
],
"tmax": "(int)",
"app": {
"bundle": "(string)",
"id": "(string)",
"publisher": {
"id": "(string)"
},
"storeurl": "(string)",
"content": {
"language": "(string)"
}
},
"bcat": [
"(array of strings)"
],
"cur": [
"(array of strings)"
],
"device": {
"lmt": "(int)",
"geo": {
"country": "(string)"
},
"carrier": "(string)",
"mccmnc": "(string)",
"connectiontype": "(int)",
"os": "(string)",
"ip": "(string)",
"ipv6": "(string)",
"dnt": "(int)",
"ifa": "(string)",
"ua": "(string)",
"devicetype": "(int)",
"make": "(string)",
"model": "(string)",
"osv": "(string)",
"h": "(int)",
"w": "(int)",
"language": "(string)",
"dpidsha1": "(string)",
"dpidmd5": "(string)",
"ext": {
"oaid": "(string)",
"gaid": "(string)",
"idfa": "(string)"
}
},
"ext": {
"notifications": {
"lurl": "(int)",
"nurl": "(int)"
}
},
"regs": {
"coppa": "(int)",
"ext": {
"gdpr": "(int)",
"nroa": {
"version": "(string)",
"mandatory": "(bool)"
}
}
},
"at": "(int)",
"test": "(int)"
}
Параметры запроса
Параметр |
Описание |
Обязательность |
Bid Request object |
||
source |
Информация о источнике запроса в объекте |
да |
id |
Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. |
да |
user |
Информация о покупателе рекламы в объекте |
да |
cur |
Список валют для ставок. Передаются следующие параметры:
|
да |
bcat |
Категории заблокированных рекламодателей согласно классификации IAB. |
нет |
imp |
Массив объектов |
да |
tmax |
Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете. |
да |
app |
Информация о приложении в объекте |
да |
ext |
Объект |
нет |
device |
Информация о конечном устройстве в объекте |
да |
regs |
Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте |
нет |
at |
Тип аукциона. Возможные значения:
|
нет |
test |
Индикатор тестового режима. Возможные значения:
|
нет |
Ext object |
||
notifications |
Объект |
нет |
Ext.Notifications object |
||
lurl |
Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:
|
нет |
nurl |
Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:
|
нет |
Imp object |
||
bidfloor |
Минимальная стоимость показа для текущего аукциона, указанная в формате CPM. |
да |
bidfloorcur |
Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей. |
да |
displaymanager |
Название монетизатора или SDK. |
нет |
id |
Идентификатор рекламного блока на HTML-странице. |
да |
instl |
Тип рекламы. Возможные варианты:
|
да |
ext |
Объект |
нет |
secure |
Тип соединения. Возможные варианты:
|
нет |
tagid |
Идентификатор места размещения объявления. |
да |
native |
Объект |
да |
displaymanagerver |
Версия монетизатора или SDK. |
да |
clickbrowser |
Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
|
да |
Imp.Native object |
||
ver |
Версия Native Markup. |
нет |
request |
Содержит закодированную строку с объектом |
да |
aurlsupport |
Флаг, указывающий на поддержку опции возврата ссылки на объект.
|
нет |
privacy |
Условия конфиденциальности.
|
нет |
plcmtcnt |
Количество блоков размещения рекламы. |
нет |
assets |
Объект |
да |
eventtrackers |
Объект |
нет |
Imp.Native.Request.Native.Assets object |
||
id |
Идентификатор ассета. |
да |
required |
Флаг, указывающий на обязательность ассета.
|
нет |
title |
Объект |
да |
img |
Объект |
нет |
data |
Объект |
нет |
Imp.Native.Request.Native.Assets.Title object |
||
len |
Длина заголовка баннера. |
да |
Imp.Native.Request.Native.Assets.Img object |
||
wmin |
Минимальная ширина изображения. |
да |
type |
Тип изображения. |
да |
hmin |
Минимальная высота изображения. |
да |
Imp.Native.Request.Native.Assets.Data object |
||
len |
Максимальная длина текста в ответе. |
нет |
type |
Тип данных в ассете. |
да |
Imp.Native.Request.Native.Eventtrackers object |
||
type |
Тип отслеживаемых событий. |
да |
method |
Способ отслеживания событий. |
да |
Imp.Ext object |
||
unmoderated |
Статус модерации аукциона. Возможные значения:
|
да |
Imp.Ext.skadn object |
||
version |
Самая старшая версия из поддерживаемых на запросе. |
нет |
versions |
Список поддерживаемых версий (в зависимости от версии SDK и версии iOS). |
нет |
sourceapp |
Идентификатор приложения (совпадает с полем app.bundle). |
нет |
skadnetids |
Список идентификаторов, получаемый из SDK. |
нет |
fidelities |
Список поддерживаемых типов fidelity, зависит от версии SKAdNetwork и SDK. |
нет |
App object |
||
bundle |
Идентфикатор приложения в AppStore или GooglePlay. |
нет |
publisher |
Информация о площадке в объекте |
да |
storeurl |
URL-адрес магазина приложений для установленного приложения. |
нет |
id |
Идентификатор приложения. |
да |
content |
Объект |
нет |
App.Publisher object |
||
id |
Идентификатор площадки. |
да |
App.Content object |
||
language |
Язык приложения. |
нет |
Device object |
||
lmt |
Ограничение отслеживания рекламы, заданное производителем конечного устройства.
|
да |
geo |
Объект |
да |
carrier |
Оператор связи или интернет-провайдер. |
нет |
connectiontype |
Тип сетевого соединения.
|
нет |
os |
Операционная система. |
да |
ip |
IP-адрес конечного устройства. |
да |
ipv6 |
IPv6-адрес конечного устройства. |
да |
dnt |
Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
|
да |
ua |
Значение HTTP-заголовка |
да |
ifa |
Рекламный идентификатор конечного устройства. |
да |
devicetype |
Тип устройства:
|
нет |
make |
Производитель устройства. |
нет |
mccmnc |
Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис. |
нет |
model |
Модель устройства. |
нет |
osv |
Версия операционной системы устройства. |
нет |
h |
Высота устройства. |
нет |
w |
Ширина устройства. |
нет |
language |
Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2. |
нет |
dpidsha1 |
Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1. |
нет |
dpidmd5 |
Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5. |
нет |
ext |
Объект |
нет |
Device.Geo object |
||
country |
Геокод страны по классификации ISO-3166-1 Alpha-3. |
да |
Device.Ext object |
||
oaid |
Идентификатор устройства. |
нет |
gaid |
Идентификатор Android-устройств. |
нет |
idfa |
Идентификатор iOS-устройств. |
нет |
User object |
||
id |
Биржевой идентификатор пользователя. |
нет |
buyeruid |
Идентификатор покупателя. |
нет |
ext |
Объект |
нет |
User.Ext object |
||
consent |
Согласие на передачу сведений о покупателе. Возможные значения:
|
нет |
Regs object |
||
coppa |
Флаг, указывающий, попадает ли запрос под действие закона о защите конфиденциальности детей в Интернете (COPPA).
|
да |
ext |
Объект |
нет |
Regs.Ext object |
||
gdpr |
Флаг, указывающий, попадает ли запрос под действие общего положения о защите данных (GDPR).
|
да |
nroa |
Родительский объект для расширения. |
нет |
Ext.nroa object |
||
version |
Номер версии. Текущую версию см. в приложении. |
нет |
mandatory |
При значении |
нет |
Source object |
||
fd |
Финальное решение о показе объявления.
|
да |
sourcetype |
Источник запроса.
|
да |
tid |
Идентификатор показа. |
да |
ext |
Объект |
нет |
Source.Ext object |
||
schain |
Объект |
нет |
Source.Ext.Schain object |
||
complete |
Флаг указывает на то, содержит ли цепочка все ноды до первоначального источника инвентаря. Возможные значения:
|
да |
nodes |
Массив объектов |
да |
ver |
Версия спецификации |
да |
Source.Ext.Schain.Nodes object |
||
asi |
Канонический домен организации, должен совпадать с доменом из ads.txt, если такой существует. |
да |
sid |
Тот же идентификатор |
да |
hp |
Указывает, должен ли этот нод быть включен в цепочку участников оплаты за инвентарь. Если значение равно 1, то организация, указанная в поле asi, платит продавцу, указанному в поле sid. Продавец — организация, которая отвечает за оплату предыдущему ноду в цепочке. Для версии 1.0 значение всегда должно быть равно 1. |
да |
rid |
OpenRTB RequestId, отправленный продавцом. |
нет |
name |
Официальное наименование организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. |
нет |
domain |
Официальный домен организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. |
нет |
Пример запроса
{
"app": {
"bundle": "com.avito.android",
"content": {
"language": "ru"
},
"id": "131313",
"publisher": {
"id": "2424224"
},
"storeurl": "https://play.google.com/store/apps/details?id=com.avito.android",
"ver": "183.6"
},
"at": 1,
"cur": [
"RUB",
"USD",
"EUR",
"TRY",
"UAH",
"KZT",
"CHF"
],
"device": {
"carrier": "Beeline",
"connectiontype": 6,
"devicetype": 4,
"dnt": 0,
"dpidmd5": "",
"dpidsha1": "",
"ext": {
"gaid": "",
"oaid": ""
},
"geo": {
"country": "RUS",
"latitude": 59.34,
"longitude": 29.61,
"region": "RU-LEN",
"type": 2
},
"h": 713,
"ifa": "e7ae-e7ae-e7ae-e7ae-08d5f943e89a",
"ip": "176.15.167.236",
"language": "ru",
"lmt": 0,
"make": "HUAWEI",
"mccmnc": "250-99",
"model": "ELE-L29",
"os": "Android",
"osv": "10",
"ua": "Dalvik/2.1.0 (Linux; U; Android 10; ELE-L29 Build/HUAWEIELE-L29)",
"w": 360
},
"ext": {
"notifications": {
"lurl": 1,
"nurl": 1
}
},
"id": "5327799747007558846",
"imp": [
{
"bidfloor": 0.5211128635,
"bidfloorcur": "USD",
"clickbrowser": 1,
"displaymanager": "Yandex Mobile Ads SDK",
"displaymanagerver": "6.0.1",
"ext": {
"unmoderated": 0
},
"id": "166",
"instl": 0,
"native": {
"request": "{\"native\":{\"ver\":\"1.2\",\"aurlsupport\":0,\"privacy\":0,\"plcmtcnt\":1,\"assets\":[{\"required\":1,\"title\":{\"len\":140},\"id\":1},{\"required\":1,\"img\":{\"wmin\":150,\"type\":3,\"hmin\":150},\"id\":2},{\"required\":0,\"data\":{\"len\":140,\"type\":2},\"id\":5},{\"required\":0,\"data\":{\"len\":10,\"type\":3},\"id\":6},{\"required\":0,\"data\":{\"len\":20,\"type\":4},\"id\":7},{\"required\":0,\"data\":{\"len\":20,\"type\":6},\"id\":8},{\"required\":0,\"data\":{\"len\":50,\"type\":11},\"id\":9},{\"required\":0,\"data\":{\"len\":15,\"type\":12},\"id\":10},{\"required\":0,\"img\":{\"wmin\":50,\"type\":1,\"hmin\":50},\"id\":11}],\"eventtrackers\":[{\"methods\":[1],\"event\":1}]}}",
"ver": "1.2"
},
"secure": 1,
"tagid": "134783-166"
}
],
"regs": {
"coppa": 0,
"ext": {
"gdpr": 0,
"nroa": {
"mandatory": true,
"version": "2"
}
}
},
"source": {
"ext": {
"schain": {
"complete": 1,
"nodes": [
{
"asi": "yandex.com",
"hp": 1,
"sid": "2412782"
}
],
"ver": "1.0"
}
},
"fd": 0,
"sourcetype": 3,
"tid": ""
},
"tmax": 500,
"user": {
"ext": {
"consent": ""
},
"id": "90994348844570239403757"
}
}