Запрос из 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)" }, "ext": { "skadn": { "version": "(string)", "versions": ["(array of strings)"], "sourceapp": "(int)", "skadnetids": [ "(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 | Информация о источнике запроса в объекте Source. | да |
id | Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. | да |
user | Информация о покупателе рекламы в объекте User. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
bcat | Категории заблокированных рекламодателей согласно классификации IAB. | нет |
imp | Массив объектов Imp, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
tmax | Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете. | да |
app | Информация о приложении в объекте App. | да |
ext | Объект Ext с дополнительными параметрами. | да |
device | Информация о конечном устройстве в объекте Device. | да |
regs | Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте Regs. | нет |
at | Тип аукциона. Возможные значения:
| нет |
test | Индикатор тестового режима. Возможные значения:
| нет |
Ext object | ||
notifications | Объект Ext.Notifications с URL-адресами уведомлений о выигрыше или проигрыше ставки. | нет |
Ext.Notifications object | ||
lurl | Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:
| нет |
nurl | Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:
| нет |
Imp object | ||
bidfloor | Минимальная стоимость показа для текущего аукциона, указанная в формате CPM. | да |
bidfloorcur | Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей. | да |
displaymanager | Название монетизатора или SDK на платформе мобильной медиации. | да |
id | Идентификатор рекламного блока на HTML-странице. | да |
instl | Тип рекламы. Возможные варианты:
| да |
ext | Объект Imp.Ext с дополнительными параметрами. | да |
secure | Тип соединения. Возможные варианты:
| нет |
tagid | Идентификатор места размещения объявления. | да |
native | Объект Imp.Native с параметрами рекламного блока. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
Imp.Native object | ||
ver | Версия Native Markup. | нет |
request | Содержит закодированную строку с объектом Native. См. пример запроса. | да |
aurlsupport | Флаг, указывающий на поддержку опции возврата ссылки на объект.
| нет |
privacy | Условия конфиденциальности.
| нет |
plcmtcnt | Количество блоков размещения рекламы. | нет |
assets | Объект Imp.Native.Request.Native.Assets с параметрами ассетов. | да |
eventtrackers | Объект Imp.Native.Request.Native.Eventtrackers с параметрами отслеживания событий. | нет |
Imp.Native.Request.Native.Assets object | ||
id | Идентификатор ассета. | да |
required | Флаг, указывающий на обязательность ассета.
| нет |
title | Объект Imp.Native.Request.Native.Assets.Title с параметрами заголовка ассета. | да |
img | Объект Imp.Native.Request.Native.Assets.Img с параметрами изображения в ассете. | нет |
data | Объект Imp.Native.Request.Native.Assets.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. | нет |
App object | ||
bundle | Идентфикатор приложения в AppStore или GooglePlay. | да |
publisher | Информация о площадке в объекте App.Publisher. | да |
storeurl | URL-адрес магазина приложений для установленного приложения. | нет |
id | Идентификатор приложения. | да |
content | Объект App.Content с информацией о содержимом приложения. | нет |
App.Publisher object | ||
id | Идентификатор площадки. | да |
App.Content object | ||
language | Язык приложения. | нет |
Device object | ||
lmt | Ограничение отслеживания рекламы, заданное производителем конечного устройства.
| да |
geo | Объект Device.Geo с описанием местоположения конечного устройства. | да |
carrier | Оператор связи или интернет-провайдер. | нет |
mccmnc | Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ifa | Рекламный идентификатор конечного устройства. | да |
devicetype | Тип устройства.
| нет |
make | Производитель устройства. | нет |
model | Модель устройства. | нет |
osv | Версия операционной системы устройства. | нет |
h | Высота устройства. | нет |
w | Ширина устройства. | нет |
language | Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2. | нет |
ext | Объект Device.Ext с дополнительными параметрами. | нет |
dpidsha1 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1. | нет |
dpidmd5 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5. | нет |
Device.Geo object | ||
country | Геокод страны по классификации ISO-3166-1 Alpha-3. | да |
Device.Ext object | ||
oaid | Идентификатор устройства. | нет |
gaid | Идентификатор Android-устройств. | нет |
idfa | Идентификатор iOS-устройств. | нет |
User object | ||
id | Биржевой идентификатор пользователя. | нет |
buyeruid | Идентификатор покупателя. | нет |
ext | Объект User.Ext с дополнительными параметрами. | нет |
User.Ext object | ||
consent | Согласие на передачу сведений о покупателе. Возможные значения:
| нет |
Regs object | ||
coppa | Флаг, указывающий, попадает ли запрос под действие закона о защите конфиденциальности детей в Интернете (COPPA).
| да |
ext | Объект Regs.Ext с дополнительными параметрами. | нет |
Regs.Ext object | ||
gdpr | Флаг, указывающий, попадает ли запрос под действие общего положения о защите данных (GDPR).
| да |
nroa | Родительский объект для расширения. | нет |
Ext.nroa object | ||
version | Номер версии. Текущую версию см. в приложении . | нет |
mandatory | При значении true сообщает о том, что ответы DSP без полной и корректной информации о договорах будут не допущены к аукциону. | нет |
Source object | ||
fd | Финальное решение о показе объявления.
| да |
sourcetype | Источник запроса.
| да |
tid | Идентификатор показа. | да |
ext | Объект Source.Ext с дополнительными параметрами. | нет |
Source.Ext object | ||
schain | Объект Source.Ext.Schain с указанием всех участников цепочки продажи инвентаря. | нет |
Source.Ext.Schain object | ||
complete | Флаг указывает на то, содержит ли цепочка все ноды до первоначального источника инвентаря. Возможные значения:
| да |
nodes | Массив объектов Source.Ext.Schain.Nodes с порядком расположения участников в цепочке. | да |
ver | Версия спецификации supply chain . На данный момент существует только версия 1.0. | да |
Source.Ext.Schain.Nodes object | ||
asi | Канонический домен организации, должен совпадать с доменом из ads.txt, если такой существует. | да |
sid | Тот же идентификатор seller_id для издателя, что и в файле sellers.json. | да |
hp | Указывает, должен ли этот нод быть включен в цепочку участников оплаты за инвентарь. Если значение равно 1, то организация, указанная в поле asi, платит продавцу, указанному в поле sid. Продавец — организация, которая отвечает за оплату предыдущему ноду в цепочке. Для версии 1.0 значение всегда должно быть равно 1. | да |
rid | OpenRTB RequestId, отправленный продавцом. | нет |
name | Официальное наименование организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. | нет |
domain | Официальный домен организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. | нет |
Параметр | Описание | Обязат. |
Bid Request object | ||
---|---|---|
source | Информация о источнике запроса в объекте Source. | да |
id | Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. | да |
user | Информация о покупателе рекламы в объекте User. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
bcat | Категории заблокированных рекламодателей согласно классификации IAB. | нет |
imp | Массив объектов Imp, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
tmax | Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете. | да |
app | Информация о приложении в объекте App. | да |
ext | Объект Ext с дополнительными параметрами. | да |
device | Информация о конечном устройстве в объекте Device. | да |
regs | Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте Regs. | нет |
at | Тип аукциона. Возможные значения:
| нет |
test | Индикатор тестового режима. Возможные значения:
| нет |
Ext object | ||
notifications | Объект Ext.Notifications с URL-адресами уведомлений о выигрыше или проигрыше ставки. | нет |
Ext.Notifications object | ||
lurl | Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:
| нет |
nurl | Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:
| нет |
Imp object | ||
bidfloor | Минимальная стоимость показа для текущего аукциона, указанная в формате CPM. | да |
bidfloorcur | Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей. | да |
displaymanager | Название монетизатора или SDK на платформе мобильной медиации. | да |
id | Идентификатор рекламного блока на HTML-странице. | да |
instl | Тип рекламы. Возможные варианты:
| да |
ext | Объект Imp.Ext с дополнительными параметрами. | да |
secure | Тип соединения. Возможные варианты:
| нет |
tagid | Идентификатор места размещения объявления. | да |
native | Объект Imp.Native с параметрами рекламного блока. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
Imp.Native object | ||
ver | Версия Native Markup. | нет |
request | Содержит закодированную строку с объектом Native. См. пример запроса. | да |
aurlsupport | Флаг, указывающий на поддержку опции возврата ссылки на объект.
| нет |
privacy | Условия конфиденциальности.
| нет |
plcmtcnt | Количество блоков размещения рекламы. | нет |
assets | Объект Imp.Native.Request.Native.Assets с параметрами ассетов. | да |
eventtrackers | Объект Imp.Native.Request.Native.Eventtrackers с параметрами отслеживания событий. | нет |
Imp.Native.Request.Native.Assets object | ||
id | Идентификатор ассета. | да |
required | Флаг, указывающий на обязательность ассета.
| нет |
title | Объект Imp.Native.Request.Native.Assets.Title с параметрами заголовка ассета. | да |
img | Объект Imp.Native.Request.Native.Assets.Img с параметрами изображения в ассете. | нет |
data | Объект Imp.Native.Request.Native.Assets.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. | нет |
App object | ||
bundle | Идентфикатор приложения в AppStore или GooglePlay. | да |
publisher | Информация о площадке в объекте App.Publisher. | да |
storeurl | URL-адрес магазина приложений для установленного приложения. | нет |
id | Идентификатор приложения. | да |
content | Объект App.Content с информацией о содержимом приложения. | нет |
App.Publisher object | ||
id | Идентификатор площадки. | да |
App.Content object | ||
language | Язык приложения. | нет |
Device object | ||
lmt | Ограничение отслеживания рекламы, заданное производителем конечного устройства.
| да |
geo | Объект Device.Geo с описанием местоположения конечного устройства. | да |
carrier | Оператор связи или интернет-провайдер. | нет |
mccmnc | Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ifa | Рекламный идентификатор конечного устройства. | да |
devicetype | Тип устройства.
| нет |
make | Производитель устройства. | нет |
model | Модель устройства. | нет |
osv | Версия операционной системы устройства. | нет |
h | Высота устройства. | нет |
w | Ширина устройства. | нет |
language | Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2. | нет |
ext | Объект Device.Ext с дополнительными параметрами. | нет |
dpidsha1 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1. | нет |
dpidmd5 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5. | нет |
Device.Geo object | ||
country | Геокод страны по классификации ISO-3166-1 Alpha-3. | да |
Device.Ext object | ||
oaid | Идентификатор устройства. | нет |
gaid | Идентификатор Android-устройств. | нет |
idfa | Идентификатор iOS-устройств. | нет |
User object | ||
id | Биржевой идентификатор пользователя. | нет |
buyeruid | Идентификатор покупателя. | нет |
ext | Объект User.Ext с дополнительными параметрами. | нет |
User.Ext object | ||
consent | Согласие на передачу сведений о покупателе. Возможные значения:
| нет |
Regs object | ||
coppa | Флаг, указывающий, попадает ли запрос под действие закона о защите конфиденциальности детей в Интернете (COPPA).
| да |
ext | Объект Regs.Ext с дополнительными параметрами. | нет |
Regs.Ext object | ||
gdpr | Флаг, указывающий, попадает ли запрос под действие общего положения о защите данных (GDPR).
| да |
nroa | Родительский объект для расширения. | нет |
Ext.nroa object | ||
version | Номер версии. Текущую версию см. в приложении . | нет |
mandatory | При значении true сообщает о том, что ответы DSP без полной и корректной информации о договорах будут не допущены к аукциону. | нет |
Source object | ||
fd | Финальное решение о показе объявления.
| да |
sourcetype | Источник запроса.
| да |
tid | Идентификатор показа. | да |
ext | Объект Source.Ext с дополнительными параметрами. | нет |
Source.Ext object | ||
schain | Объект Source.Ext.Schain с указанием всех участников цепочки продажи инвентаря. | нет |
Source.Ext.Schain object | ||
complete | Флаг указывает на то, содержит ли цепочка все ноды до первоначального источника инвентаря. Возможные значения:
| да |
nodes | Массив объектов Source.Ext.Schain.Nodes с порядком расположения участников в цепочке. | да |
ver | Версия спецификации supply chain . На данный момент существует только версия 1.0. | да |
Source.Ext.Schain.Nodes object | ||
asi | Канонический домен организации, должен совпадать с доменом из ads.txt, если такой существует. | да |
sid | Тот же идентификатор seller_id для издателя, что и в файле sellers.json. | да |
hp | Указывает, должен ли этот нод быть включен в цепочку участников оплаты за инвентарь. Если значение равно 1, то организация, указанная в поле asi, платит продавцу, указанному в поле sid. Продавец — организация, которая отвечает за оплату предыдущему ноду в цепочке. Для версии 1.0 значение всегда должно быть равно 1. | да |
rid | OpenRTB RequestId, отправленный продавцом. | нет |
name | Официальное наименование организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. | нет |
domain | Официальный домен организации, поле не должно присутствовать в объекте, если организация указана в sellers.json. | нет |
Пример запроса
{ "app": { "bundle": "336435697", "id": "1466531", "publisher": { "id": "0" }, "content": { "language": "ru" } }, "at": 1, "cur": [ "RUB", "USD", "EUR", "TRY", "UAH", "KZT", "CHF" ], "device": { "carrier": "23410", "connectiontype": 0, "devicetype": 1, "dnt": 0, "dpidmd5": "306ae45f631d9cba6df9450b2d06cce1", "dpidsha1": "9e9b90848b103d23e99be99d99ecff397b45024e", "ext": {}, "geo": { "country": "GBR" }, "ip": "2.217.22.0", "ipv6": "::ffff:2.217.22.0", "language": "en", "lmt": 0, "make": "apple", "mccmnc": "", "model": "ipad", "os": "iOS", "osv": "14.7.1", "ua": "Mozilla/5.0 (iPad; CPU iPad OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148" }, "ext": { "notifications": { "lurl": 1, "nurl": 1, "gaid": , "idfa": "1DB9B91B-7520-4807-8D87-BE362369646E", "oaid": } }, "id": "1235558418521588268", "imp": [ { "bidfloor": 1.54, "bidfloorcur": "RUB", "clickbrowser": 1, "displaymanager": "", "displaymanagerver": "2022.01.0305", "ext": { "unmoderated": 0 }, "ext": { "skadn": { "version": "2.0", "versions": ["2.0", "2.1", "3.0"], "sourceapp": "880047117", "skadnetids": [ "dticjx1a9i.skadnetwork", "8srfag4vvc.skadnetwork" ] } } "id": "1", "instl": 0, "native": { "request": "{\"native\":{\"ver\":\"1.2\",\"aurlsupport\":0,\"privacy\":0,\"plcmtcnt\":1,\"assets\":[{\"title\":{\"len\":\"50\"},\"id\":\"1\"},{\"data\":{\"type\":\"2\",\"len\":\"150\"},\"id\":\"2\"},{\"data\":{\"type\":\"12\",\"len\":\"15\"},\"id\":\"3\"},{\"id\":\"4\",\"img\":{\"wmin\":\"50\",\"hmin\":\"50\",\"type\":\"1\"}},{\"required\":\"1\",\"img\":{\"wmin\":\"320\",\"hmin\":\"160\",\"type\":\"3\"},\"id\":\"5\"}],\"eventtrackers\":[{\"methods\":[1],\"event\":1}]}}", "ver": "1.2" }, "secure": 1, "tagid": "1466531-1" } ], "regs": { "coppa": 0, "ext": { "gdpr": 1, "nroa": { "version": "2", "mandatory": true } } }, "source": { "fd": 0, "sourcetype": 3, "tid": "" }, "tmax": 200, "user": { "id": "108799773262946888", "buyeruid": "8fahfsfd9a", "ext": { "consent": "0" } } }
Скопировано