Спецификации открытого тендерного запроса RTB
На этой странице описаны различные компоненты RTB-запросов, которые вы получите для участия в торгах.
Заголовки конкурсных заявок
- HTTP-заголовок версии OpenRTB: x-openrtb-version: 2.4
- hTTP-заголовок Keep-Alive HTTP Header**: Соединение: Keep-Alive
- Содержание JSON: Content-Type: application/json
- Заголовок кодировки данных: Accept-Encoding
Заявка на участие в торгах
When requesting bids for a specific context, the platform will perform an HTTP request with a timeout of 300ms and send the following object encoded as JSON in the request body. HTTP is recommended due to extra latency when using HTTPS.
| Атрибут | Описание |
|---|
| на | Тип аукциона, первая цена = 1 (int) |
| id | Уникальный идентификатор заявки на участие в торгах (строка) |
| имп | Объект, представляющий предлагаемое впечатление(объект). |
| сайт | Подробная информация через объект Site о сайте (объекте) издателя. |
| устройство | Сведения через объект Device об устройстве пользователя, на которое будет доставлено впечатление (объект). |
| пользователь | Подробная информация через объект User о человеке, пользующемся устройством; рекламная аудитория (объект). |
| ext | Держатель для специфических для биржи расширений. |
имп
| Атрибут | Описание |
|---|
| id | Уникальный идентификатор впечатления в данном запросе на участие в торгах (строка) |
| bidfloor | Минимальная ставка за данное впечатление (CPM) / клик (CPC) и валюта счета, необязательно (плавающая). |
| bidfloorcur | Валюта для минимального значения ставки, указанная с использованием альфа-кодов ISO-4217, необязательно (строка) |
| родной | Объект Native ; требуется, если это впечатление предлагается как возможность (объект) нативной рекламы. |
| баннер | Объект баннера ; требуется, если это впечатление предлагается как возможность (объект) баннерной рекламы. |
| instl | Объект interstitial ; требуется, если это впечатление предлагается в качестве возможности (объекта) интерстициального объявления. |
| безопасный | Флаг, указывающий, требует ли впечатление безопасного HTTPS URL творческих активов и разметки, где 0 = небезопасный, 1 = безопасный. Если флаг опущен, состояние безопасности неизвестно, но можно предположить поддержку небезопасного HTTP, необязательно (целое число) |
| el | Электронная почта в кодировке Base64 (строка) |
имп.знамя
| Атрибут | Описание |
|---|
| w | Ширина баннера в пикселях (целое число). |
| h | Высота баннера в пикселях (целое число). |
имп.инстл
| Атрибут | Описание |
|---|
| instl | Флаг, указывающий, является ли объявление popunder/interstitial (целое число): 1=правда, 0=ложь |
imp.native (нативные и Push-уведомления)
| Атрибут | Описание |
|---|
| запрос | Полезная нагрузка запроса, соответствующая спецификации Native Ad Specification - JSON-кодированная строка запроса Native Ads, включая его нативный объект верхнего уровня (JSON-объект) |
| ver | Версия API Dynamic Native Ads, которой соответствует request (строка) |
imp.native.request
| Атрибут | Описание |
|---|
| ver | Версия используемой нативной разметки (строка) |
| контекст | Контекст, в котором появляется объявление. В данном случае это 1 (контекст, ориентированный на контент, такой как лента новостей, статья, галерея изображений, видеогалерея или аналогичный контекст), необязательно (целое число) |
| plcmttype | Дизайн/формат/разметка предлагаемого рекламного блока. В настоящее время мы поддерживаем 4 (Виджет рекомендаций) и 500 (Толковое уведомление) (целое число) |
| plcmtcnt | Количество одинаковых мест в этом макете (целое число) |
| активы | Массив Объектов активов. Любой ответ на заявку должен соответствовать массиву элементов, выраженному в заявке (массив объектов JSON) |
| seq | 0 для первого объявления, 1 для второго и так далее. Обратите внимание, что это обычно НЕ используется в сочетании с plcmtcnt - либо вы выставляете на аукцион несколько одинаковых объявлений (в этом случае plcmtcnt>1, seq=0), либо вы проводите отдельные аукционы для разных элементов в ленте (в этом случае plcmtcnt=1, seq=>=1) |
imp.native.request.assets
| Атрибут | Описание |
|---|
| id | Уникальный идентификатор актива, присваиваемый биржей. Обычно является счетчиком для массива (целое число) |
| требуется | Установите значение 1, если актив является обязательным, или 0, если актив является необязательным** (целое число) |
| plcmtcnt | Количество одинаковых мест в этом макете (целое число) |
| img | Объект изображения для активов изображения* (объект JSON) |
| название | Объект заголовка для титульных активов* (объект JSON) |
| данные | Объект данных для названия бренда, описания, рейтинга, цены и т.д.* (объект JSON) |
| видео | Видеообъект для видеоактивов. См. определение объекта запроса видео. Обратите внимание, что видеореклама в потоке (т. е. преролл и т. д.) не является частью Native. Рекламные объявления Native могут содержать видео в качестве самого рекламного креатива (объекта). |
* Только один из объектов {img, title, data} должен присутствовать в каждом объекте актива
** Активы помечаются по мере необходимости в соответствии с конфигурацией зоны издателя, в которой может быть показано ваше объявление
imp.native.request.assets.img
| Атрибут | Описание |
|---|
| тип | Идентификатор типа элемента изображения, поддерживаемого издателем. Мы поддерживаем: 1 (Иконка изображения) (целое число), 3 (Большое изображение для предварительного просмотра объявления) (целое число) |
| w | Ширина изображения в пикселях, необязательно (целое число) |
| h | Высота изображения в пикселях, необязательно (целое число) |
| wmin | Минимальная запрашиваемая ширина изображения в пикселях (целое число) |
| hmin | Минимальная запрашиваемая высота изображения в пикселях (целое число) |
imp.native.request.assets.title
| Атрибут | Описание |
|---|
| len | Максимальная длина текста в элементе title. (целое число) |
imp.native.request.assets.data
| Атрибут | Описание |
|---|
| тип | Идентификатор типа элемента, поддерживаемого издателем (целое число). Мы поддерживаем: 1 (sponsored - сообщение Sponsored By, где ответ должен содержать название бренда спонсора), 2 (desc - описательный текст, связанный с рекламируемым товаром или услугой) |
| len | Максимальная длина текста в ответе элемента (целое число) |
| <!-- | |
| ### imp.native.request.assets.video | |
| Атрибут | Описание |
|---|
| мимы | Список поддерживаемых типов мимов (массив строк) |
| мышление | Минимальная продолжительность видеорекламы в секундах (int). |
| maxduration | Максимальная продолжительность видеорекламы в секундах (int). |
| протоколы | Список поддерживаемых протоколов ответа на видеозаявку (массив int) |
| линейность | Указывает, должен ли оттиск быть линейным, нелинейным и т. д. (int) |
| бокс разрешен | Указывает, разрешено ли переводить содержимое формата 4:3 в формат 16:9 (int) |
| --> | |
имп.видео
| Атрибут | Описание |
|---|
| мимы | Список поддерживаемых типов мимов (массив строк) |
| протоколы | Список поддерживаемых протоколов ответа на видеозаявку (массив int) |
| пропустить | Указывает, будет ли плеер разрешать пропуск видео, где 0 = нет, 1 = да |
| пропустить после | Количество секунд, в течение которых видео должно проигрываться, прежде чем будет включена функция пропуска; применимо только в том случае, если реклама пропускается |
| skipmin | Видеоролики общей продолжительностью более указанного количества секунд могут быть пропущены; применимо только в том случае, если реклама пропускается |
Примечание: Если издатель указывает в запросе "skip", но не указывает "skipafter", видео будет пропускаться через 5 секунд. В ответе будет установлено значение "skipoffset", равное 5. Если издатель укажет "skip", но не укажет "skipmin", видео будет пропускаться независимо от его продолжительности.
сайт
| Атрибут | Описание |
|---|
| id* | Уникальный идентификатор сайта (строка) |
| домен* | Доменное имя сайта (строка) |
| кот | Идентификатор категории IAB (массив строк) |
| страница | Полный URL-адрес страницы, на которой будет показано объявление (строка) |
| ключевые слова | Ключевые слова можно использовать для того, чтобы рекламные зоны получали нужный тип рекламы. Ключевые слова должны представлять собой строку слов, разделенных запятыми |
| ext | Место для специфических для биржи расширений OpenRTB. |
*Эти атрибуты обязательны для форматов Direct Link и Email Clicks.
site.ext
| Атрибут | Описание |
|---|
| обменник | Идентификатор пользовательской категории ExoClick (целое число) |
| idzone | Пользовательский идентификатор рекламной зоны ExoClick (целое число) |
| ключевое слово | Соответствующее ключевое слово, если таковое имеется (строка) |
Атрибут idzone используется для определения источника в ExoClick, из которого поступает трафик.
устройство
| Атрибут | Описание |
|---|
| ua | Агент пользователя браузера (строка) |
| гео | Предполагается, что местоположение устройства - это текущее местоположение пользователя, определяемое объектом Geo. |
| ip | IP-адрес пользователя (строка)* |
| ipv6 | IPv6-адрес пользователя (строка)* |
| язык | Язык браузера, использующий ISO-639-1-alpha-2 (строка) |
| os | Операционная система (строка) |
| js | Поддержка JavaScript, где 0 = нет, 1 = да (целое число) |
| ext | Место для расширения OpenRTB, специфичного для биржи |
устройство.гео
| Атрибут | Описание |
|---|
| страна | Страна ISO3 |
устройство.ext
| Атрибут | Описание |
|---|
| удалённый_адрес | Основной IP-адрес пользователя (строка) |
| x_forwarded_for | X-FORWARDED-FOR IP-адрес пользователя или пустой, если он не установлен (строка) |
пользователь
| Атрибут | Описание |
|---|
| id | Уникальный идентификатор пользователя (строка) |
ext
| Атрибут | Требуется? | Описание |
|---|
| суб | Нет | В качестве sub будет использоваться целое число, представляющее собой идентификатор зоны, из которой поступил запрос. |
regs.ext
| Атрибут | Описание |
|---|
| dsaapply | Флаг, указывающий, применяется ли DSA к запросу. 1 = Требуется (int) |
| dsa | Расширение для информации о прозрачности DSA (объект) |
regs.ext.dsa
| Атрибут | Описание |
|---|
| требуется | Флаг, указывающий, должна ли быть доступна информация DSA. 0 = Не требуется, 1 = Поддерживается, ответы на конкурсные предложения с объектом DSA или без него будут приняты, 2 = Требуется, ответы на конкурсные предложения без объекта DSA не будут приняты, 3 = Требуется, ответы на конкурсные предложения без объекта DSA не будут приняты, Издатель - онлайн-платформа (int) |
| datatopub | Данные о прозрачности могут понадобиться издателю для целей аудита. 0 = не отправлять данные о прозрачности, 1 = необязательно отправлять данные о прозрачности, 2 = отправлять данные о прозрачности (int) |
Примечание: *Если вы получили dsaapply: 1 и required: 2 или 3, необходимо добавить в ответ атрибуты dsa со значениями, иначе ответ будет отклонен.
Примеры
You can find a complete list of all the types of requests you can receive in our Advertiser Request example page.