Запрос из 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": { "id": "(string)", "ext": { "consent": "(string)" } }, "imp": [ { "bidfloor": "(float)", "bidfloorcur": "(string)", "displaymanager": "(string)", "id": "(string)", "instl": "(int)", "ext": { "reward": "(int)", "unmoderated": "(int)" }, "secure": "(int)", "tagid": "(string)", "displaymanagerver": "(string)", "clickbrowser": "(int)", "video": { "h": "(int)", "mimes": [ "(array of strings)" ], "protocols": [ "(array of int)" ], "w": "(int)", "api": [ "(array of int)" ], "minduration": "(int)", "maxduration": "(int)", "skip": "(int)", "playbackmethod": [ "(array of int)" ], "minbitrate": "(int)", "maxbitrate": "(int)", "startdelay": "(int)", "placement": "(int)", "linearity": "(int)", "pos": "(int)", "ext": { "nroa": { "markup_version": (int) } } } } ], "tmax": "(int)", "site": { "content": { "language": "(string)" }, "domain": "(string)", "id": "(string)", "page": "(string)", "publisher": { "id": "(string)" } }, "cur": [ "(array of strings)" ], "device": { "lmt": "(int)", "geo": { "country": "(string)" }, "carrier": "(string)", "connectiontype": "(int)", "os": "(string)", "ip": "(string)", "ipv6": "(string)", "dnt": "(int)", "ifa": "(string)", "ua": "(string)", "devicetype": "(int)", "make": "(string)", "mccmnc": "(string)", "model": "(string)", "osv": "(string)", "h": "(int)", "w": "(int)", "language": "(string)", "dpidsha1": "(string)", "dpidmd5": "(string)", "ext": { "oaid": "(string)", "gaid": "(string)", "idfa": "(string)" } }, "regs": { "coppa": "(int)", "ext": { "gdpr": "(int)", "nroa": { "version": "(string)", "mandatory": "(bool)" } } }, "at": "(int)", "test": "(int)", "ext": { "notifications": { "lurl": "(int)", "nurl": "(int)" } } }
Скопировано
Параметр | Описание | Обязат. |
Bid Request object | ||
---|---|---|
source | Информация о источнике запроса в объекте Source. | да |
id | Идентификатор аукциона, присвоенный RTB-хостом. DSP возвращает этот идентификатор в ответе. | да |
user | Информация о покупателе рекламы в объекте User. | да |
imp | Массив объектов Impression, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
tmax | Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете. | да |
app | Информация о приложении в объекте App. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
device | Информация о конечном устройстве в объекте Device. | да |
regs | Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте Regs. | нет |
at | Тип аукциона. Возможные значения:
| нет |
test | Индикатор тестового режима. Возможные значения:
| нет |
ext | Объект Ext с дополнительными параметрами. | нет |
Ext object | ||
notifications | Объект Ext.Notifiactions с URL-адресами уведомлений о выигрыше или проигрыше ставки. | нет |
Ext.Notifications object | ||
lurl | Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:
| нет |
nurl | Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:
| нет |
Imp object | ||
bidfloor | Минимальная стоимость показа для текущего аукциона, указанная в формате CPM. | да |
bidfloorcur | Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей. | да |
displaymanager | Название монетизатора или SDK. | нет |
id | Идентификатор рекламного блока на HTML-странице. | да |
instl | Тип рекламы. Возможные варианты:
| да |
secure | Тип соединения. Возможные варианты:
| нет |
ext | Объект Imp.Ext с дополнительными параметрами. | да |
tagid | Идентификатор места размещения объявления. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
video | Объект Imp.Video с параметрами показа видео. | нет |
Imp.Video object | ||
mimes | Поддерживаемые типы контента MIME. | да |
protocols | Поддерживаемые протоколы передачи видео. | нет |
h | Высота видеоплеера в пикселях. | нет |
w | Ширина видеоплеера в пикселях. | нет |
api | Список поддерживаемых API для этого показа. | нет |
minduration | Минимальная продолжительность видео в секундах. | нет |
maxduration | Максимальная продолжительность видео в секундах. | нет |
skip | Показывает, допускает ли видеоплеер пропуск видео:
| нет |
playbackmethod | Допустимые методы воспроизведения видео. Если ничего не указано, можно использовать любой метод. | нет |
minbitrate | Минимальный битрейт в кбит/с. | нет |
maxbitrate | Максимальный битрейт в кбит/с. | нет |
startdelay | Показывает задержку начала воспроизведения в секундах для размещения рекламы в:
| нет |
placement | Тип размещения видеобаннера:
| нет |
linearity | Линейность видеобаннера. Возможные значения:
| нет |
pos | Расположение баннера на экране. Возможные значения:
| нет |
ext | Объект с дополнительными параметрами. | нет |
Video.Ext object | ||
nroa | Родительский объект расширения. | нет |
Video.Ext.nroa object | ||
markup_version | Номер версии маркировки видео. | нет |
Imp.Ext object | ||
reward | Реклама с вознаграждением. Возможные варианты:
| нет |
unmoderated | Статус модерации аукциона. Возможные значения:
| да |
Site object | ||
publisher | Информация о площадке в объекте Site.Publisher. | да |
id | Идентификатор приложения. | да |
content | Объект Site.Content с информацией о содержимом приложения. | нет |
page | URL страницы, на которой будет показано объявление. | нет |
domain | Домен сайта. | нет |
Site.Publisher object | ||
id | Идентификатор площадки. | да |
Site.Content object | ||
language | Язык приложения. | нет |
Device object | ||
lmt | Ограничение отслеживания рекламы, заданное производителем конечного устройства.
| да |
geo | Объект Device.Geo с описанием местоположения конечного устройства. | да |
carrier | Оператор связи или интернет-провайдер. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ifa | Рекламный идентификатор конечного устройства. | да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
devicetype | Тип устройства.
| нет |
make | Производитель устройства. | нет |
mccmnc | Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис. | нет |
model | Модель устройства. | нет |
osv | Версия операционной системы устройства. | нет |
h | Высота устройства. | нет |
w | Ширина устройства. | нет |
language | Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2. | нет |
dpidsha1 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1. | нет |
dpidmd5 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5. | нет |
ext | Объект Device.Ext с дополнительными параметрами. | нет |
Device.Geo object | ||
country | Геокод страны по классификации ISO-3166-1 Alpha-3. | да |
Device.Ext object | ||
oaid | Идентификатор устройства. | нет |
gaid | Идентификатор Android-устройств. | нет |
idfa | Идентификатор iOS-устройств. | нет |
User object | ||
id | Биржевой идентификатор пользователя. | нет |
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. | да |
imp | Массив объектов Impression, которые содержат параметры визуализации баннера. Каждый объект соответствует одному рекламному блоку на HTML-странице. В текущей реализации передается один объект. | да |
tmax | Максимальное время ответа в миллисекундах, в течение которого нужно сделать ставку, с учетом задержки в интернете. | да |
app | Информация о приложении в объекте App. | да |
cur | Список валют для ставок. Передаются следующие параметры:
| да |
device | Информация о конечном устройстве в объекте Device. | да |
regs | Отраслевые, правовые или правительственные нормативные акты, действующие для всех показов в запросе, в объекте Regs. | нет |
at | Тип аукциона. Возможные значения:
| нет |
test | Индикатор тестового режима. Возможные значения:
| нет |
ext | Объект Ext с дополнительными параметрами. | нет |
Ext object | ||
notifications | Объект Ext.Notifiactions с URL-адресами уведомлений о выигрыше или проигрыше ставки. | нет |
Ext.Notifications object | ||
lurl | Вероятность вызова ссылки-уведомления о проигрыше. Возможные статусы:
| нет |
nurl | Вероятность вызова ссылки-уведомления о выигрыше. Возможные статусы:
| нет |
Imp object | ||
bidfloor | Минимальная стоимость показа для текущего аукциона, указанная в формате CPM. | да |
bidfloorcur | Буквенный код валюты в формате ISO-4217. Может отличаться от валюты предложения, возвращенной участником торгов, если это разрешено биржей. | да |
displaymanager | Название монетизатора или SDK. | нет |
id | Идентификатор рекламного блока на HTML-странице. | да |
instl | Тип рекламы. Возможные варианты:
| да |
secure | Тип соединения. Возможные варианты:
| нет |
ext | Объект Imp.Ext с дополнительными параметрами. | да |
tagid | Идентификатор места размещения объявления. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
video | Объект Imp.Video с параметрами показа видео. | нет |
Imp.Video object | ||
mimes | Поддерживаемые типы контента MIME. | да |
protocols | Поддерживаемые протоколы передачи видео. | нет |
h | Высота видеоплеера в пикселях. | нет |
w | Ширина видеоплеера в пикселях. | нет |
api | Список поддерживаемых API для этого показа. | нет |
minduration | Минимальная продолжительность видео в секундах. | нет |
maxduration | Максимальная продолжительность видео в секундах. | нет |
skip | Показывает, допускает ли видеоплеер пропуск видео:
| нет |
playbackmethod | Допустимые методы воспроизведения видео. Если ничего не указано, можно использовать любой метод. | нет |
minbitrate | Минимальный битрейт в кбит/с. | нет |
maxbitrate | Максимальный битрейт в кбит/с. | нет |
startdelay | Показывает задержку начала воспроизведения в секундах для размещения рекламы в:
| нет |
placement | Тип размещения видеобаннера:
| нет |
linearity | Линейность видеобаннера. Возможные значения:
| нет |
pos | Расположение баннера на экране. Возможные значения:
| нет |
ext | Объект с дополнительными параметрами. | нет |
Video.Ext object | ||
nroa | Родительский объект расширения. | нет |
Video.Ext.nroa object | ||
markup_version | Номер версии маркировки видео. | нет |
Imp.Ext object | ||
reward | Реклама с вознаграждением. Возможные варианты:
| нет |
unmoderated | Статус модерации аукциона. Возможные значения:
| да |
Site object | ||
publisher | Информация о площадке в объекте Site.Publisher. | да |
id | Идентификатор приложения. | да |
content | Объект Site.Content с информацией о содержимом приложения. | нет |
page | URL страницы, на которой будет показано объявление. | нет |
domain | Домен сайта. | нет |
Site.Publisher object | ||
id | Идентификатор площадки. | да |
Site.Content object | ||
language | Язык приложения. | нет |
Device object | ||
lmt | Ограничение отслеживания рекламы, заданное производителем конечного устройства.
| да |
geo | Объект Device.Geo с описанием местоположения конечного устройства. | да |
carrier | Оператор связи или интернет-провайдер. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ifa | Рекламный идентификатор конечного устройства. | да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
devicetype | Тип устройства.
| нет |
make | Производитель устройства. | нет |
mccmnc | Уникальный идентификатор оператора мобильной связи, получаемый объединением кодов MCC и MNC через дефис. | нет |
model | Модель устройства. | нет |
osv | Версия операционной системы устройства. | нет |
h | Высота устройства. | нет |
w | Ширина устройства. | нет |
language | Язык, выбранный в браузере. Используемый формат — ISO-639-1-alpha-2. | нет |
dpidsha1 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму SHA1. | нет |
dpidmd5 | Идентификатор платформы устройства (например, идентификатор Android), хешированный по алгоритму MD5. | нет |
ext | Объект Device.Ext с дополнительными параметрами. | нет |
Device.Geo object | ||
country | Геокод страны по классификации ISO-3166-1 Alpha-3. | да |
Device.Ext object | ||
oaid | Идентификатор устройства. | нет |
gaid | Идентификатор Android-устройств. | нет |
idfa | Идентификатор iOS-устройств. | нет |
User object | ||
id | Биржевой идентификатор пользователя. | нет |
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. | нет |
Пример запроса
{ "site": { "page": "https://banners.adfox.ru/201208/adfox/1300062/2b9df8c5d7bd3400f1c1702953801bc8_index.html", "domain": "adfox.ru", "publisher": { "id": "944028" }, "id": "215876", "content": { "language": "ru" } }, "at": 1, "cur": [ "RUB", "USD", "EUR", "TRY", "UAH", "KZT", "CHF" ], "device": { "carrier": "MTS RUS", "connectiontype": 2, "devicetype": 1, "dnt": 0, "dpidmd5": "", "dpidsha1": "", "ext": { "gaid": "851391a2-cb10-4edf-8e89-cdasdf9430", "idfa": "", "oaid": "" }, "geo": { "country": "RUS" }, "h": 838, "ifa": "851391a2-cb10-4edf-8e89-cdasdf9430", "ip": "109.252.147.115", "ipv6": "::ffff:109.252.147.115", "language": "ru", "lmt": 0, "make": "motorola", "mccmnc": "250-1", "model": "moto g(20)", "os": "Android", "osv": "11", "ua": "Dalvik/2.1.0 (Linux; U; Android 11; moto g(20) Build/RTAS31.68-29-2)", "w": 411 }, "ext": { "notifications": { "lurl": 1, "nurl": 1 } }, "id": "2613544480608676485", "imp": [ { "bidfloor": 0.0001567892, "bidfloorcur": "USD", "clickbrowser": 1, "displaymanager": "Yandex Mobile Ads SDK", "displaymanagerver": "4.4.1", "ext": { "reward": 0, "unmoderated": 0 }, "id": "14", "instl": 0, "secure": 1, "tagid": "1354193-14", "video": { "h": 400, "mimes": [ "video/mp4" ], "protocols": [ 3, 6, 7, 8 ], "w": 240, "api": [ 5 ], "minduration": 5, "maxduration": 30, "skip": 0, "playbackmethod": [ 2 ], "minbitrate": 400, "maxbitrate": 1000, "startdelay": -1, "placement": 1, "linearity": 1, "pos": 0, "ext": { "nroa": { "markup_version": 1 } } } } ], "regs": { "coppa": 0, "ext": { "gdpr": 0, "nroa": { "version": "2", "mandatory": true } } }, "source": { "fd": 0, "sourcetype": 3, "tid": "", "ext": { "schain": { "complete": 1, "nodes": [ { "asi": "yandex.com", "sid": "12345", "hp": 1, "rid": "bidrequest123" } ], "ver": "1.0" } } }, "tmax": 500, "user": { "id": "108799773262946888", "ext": { "consent": "0" } } }
Скопировано