Запрос из 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)", "banner": { "api": [ "(array of int)" ], "format": [ { "h": "(int)", "w": "(int)" } ], "h": "(int)", "w": "(int)" }, "displaymanagerver": "(string)", "clickbrowser": "(int)" } ], "tmax": "(int)", "app": { "bundle": "(string)", "publisher": { "id": "(string)" }, "storeurl": "(string)", "id": "(string)", "content": { "language": "(string)" } }, "bcat": [ "(array of strings)" ], "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. | да |
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 | Идентификатор места размещения объявления. | да |
banner | Объект Imp.Banner с размерами рекламного блока по умолчанию. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
Imp.Banner object | ||
api | Список поддерживаемых платформ API. | нет |
format | Объект Imp.Banner.Format с допустимыми размерами рекламного блока. | да |
h | Высота блока в пикселях. | да |
w | Ширина блока в пикселях. | да |
Imp.Banner.Format object | ||
h | Высота блока в пикселях. | да |
w | Ширина блока в пикселях. | да |
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 | Оператор связи или интернет-провайдер. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ifa | Рекламный идентификатор конечного устройства. | да |
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 | Биржевой идентификатор пользователя. | нет |
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 | Идентификатор места размещения объявления. | да |
banner | Объект Imp.Banner с размерами рекламного блока по умолчанию. | да |
displaymanagerver | Версия монетизатора или SDK. | да |
clickbrowser | Тип браузера, открываемого при нажатии на креатив в приложении. Возможные значения:
| да |
Imp.Banner object | ||
api | Список поддерживаемых платформ API. | нет |
format | Объект Imp.Banner.Format с допустимыми размерами рекламного блока. | да |
h | Высота блока в пикселях. | да |
w | Ширина блока в пикселях. | да |
Imp.Banner.Format object | ||
h | Высота блока в пикселях. | да |
w | Ширина блока в пикселях. | да |
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 | Оператор связи или интернет-провайдер. | нет |
connectiontype | Тип сетевого соединения.
| нет |
os | Операционная система. | да |
ip | IP-адрес конечного устройства. | да |
ipv6 | IPv6-адрес конечного устройства. | да |
dnt | Ограничение отслеживания рекламы, заданное пользователем конечного устройства.
| да |
ua | Значение HTTP-заголовка User-Agent — название приложения на конечном устройстве. | да |
ifa | Рекламный идентификатор конечного устройства. | да |
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 | Биржевой идентификатор пользователя. | нет |
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. | нет |
Пример запроса
{ "source": { "fd": 0, "sourcetype": 3, "tid": "", "ext": { "schain": { "complete": 1, "nodes": [ { "asi": "yandex.com", "sid": "12345", "hp": 1, "rid": "bidrequest123" } ], "ver": "1.0" } } }, "id": "5834842956793170835", "user": { "buyeruid": "8fahfsfd9a", "id": "108799773262946888", "ext": { "consent": "1" } }, "imp": [ { "bidfloor": 0.01, "bidfloorcur": "USD", "displaymanager": "Yandex Mobile Ads SDK", "id": "10", "instl": 0, "ext": { "unmoderated": 0 }, "ext": { "skadn": { "version": "2.0", "versions": ["2.0", "2.1", "3.0"], "sourceapp": "880047117", "skadnetids": [ "dticjx1a9i.skadnetwork", "8srfag4vvc.skadnetwork" ] } } "secure": 1, "tagid": "123123-10", "banner": { "format": [ { "h": 300, "w": 300 }, { "h": 50, "w": 320 }, { "h": 250, "w": 300 }, { "h": 100, "w": 320 } ], "h": 250, "w": 300 }, "displaymanagerver": "3.5.0", "clickbrowser": 1 } ], "tmax": 200, "app": { "bundle": "ru.scanword.sloword", "publisher": { "id": "4626422" }, "id": "123123", "content": { "language": "ru" } }, "bcat": [ "" ], "cur": [ "RUB", "USD", "EUR", "TRY", "UAH", "KZT", "CHF" ], "device": { "lmt": 0, "ua": "com.yandex.mobile.metrica.ads.sdk/2.10 (Apple iPhone7,1; iOS 11.2.6) 229abba2", "ip": "", "ifa": "1DB9B91B-7520-4807-8D87-BE362369646E", "mccmnc": "", "dpidmd5": "", "geo": { "country": "RUS" }, "dpidsha1": "", "carrier": "", "connectiontype": 0, "model": "iPhone7,1", "osv": "11.2.6", "make": "Apple", "os": "iOS", "devicetype": 1, "ipv6": "2a02:6b8:81:0:8cf6:c67:9042:972b", "w": 414, "h": 736, "dnt": 0, "language": "ru", "ext": { "gaid": "", "idfa": "1DB9B91B-7520-4807-8D87-BE362369646E", "oaid": "" } }, "regs": { "coppa": 0, "ext": { "gdpr": 0, "nroa": { "version": "2", "mandatory": true } } }, "at": 1, "ext": { "notifications": { "lurl": 1, "nurl": 1 } } }
Скопировано