For the complete documentation index, see llms.txt. This page is also available as Markdown.

Запрос на бид Open RTB 2.4

На этой странице описываются различные компоненты RTB-запросов, которые вы будете получать для размещения ставок.

Заголовки запроса ставки

  • HTTP-заголовок версии OpenRTB: x-openrtb-version: 2.4

  • HTTP-заголовок Keep-Alive: Connection: Keep-Alive

  • JSON-содержимое: Content-Type: application/json

  • Заголовок кодирования данных: Accept-Encoding

Объект запроса ставки

При запросе ставок для конкретного контекста платформа выполнит HTTP-запрос с тайм-аутом 300 мс и отправит следующий объект, закодированный как JSON, в теле запроса. HTTP рекомендуется из-за дополнительной задержки при использовании HTTPS.

Атрибут
Описание

в

Тип аукциона, первая цена = 1 (целое число)

id

Уникальный ID запроса ставки (строка)

imp

Объект, представляющий предлагаемый показ (объект).

site

Сведения об веб-сайте издателя через объект Site (объект).

device

Сведения об устройстве пользователя, которому будет показан показ, через объект Device (объект).

user

Сведения о человеке-пользователе устройства; рекламная аудитория (объект).

ext

Заполнитель для расширений, специфичных для биржи.

imp

Атрибут
Описание

id

Уникальный ID показа в этом запросе ставки (строка)

bidfloor

Минимальная ставка для этого показа (CPM) / клика (CPC) и валюта аккаунта, необязательно (число с плавающей точкой).

bidfloorcur

Валюта для минимального значения ставки, указанная по кодам ISO-4217 alpha, необязательно (строка)

native

Объект Native; обязателен, если этот показ предлагается как возможность нативной рекламы (объект).

banner

Объект баннера; обязателен, если этот показ предлагается как возможность баннерной рекламы (объект).

instl

Объект interstitial; обязателен, если этот показ предлагается как возможность interstitial- или popunder-рекламы (объект).(объект).

secure

Флаг, указывающий, требует ли показ защищённых HTTPS URL-ресурсов креатива и разметки, где 0 = небезопасно, 1 = безопасно. Если не указан, состояние безопасности неизвестно, но можно предположить поддержку небезопасного HTTP, необязательно (целое число)

el

Электронная почта, закодированная в Base64 (строка)

imp.banner

Атрибут
Описание

w

Ширина баннера в пикселях (целое число).

h

Высота баннера в пикселях (целое число).

mimes

Поддерживаемые MIME-типы. Примеры значений: image/jpg, image/png, video/mp4, image/webp.

imp.instl

Атрибут
Описание

instl

Флаг, указывающий, является ли реклама popunder/interstitial (целое число): 1=true, 0=false

imp.native (Native и Push Notifications)

Атрибут
Описание

request

Тело запроса, соответствующее спецификации Native Ad, — это строка, закодированная в JSON запроса Native Ads, включая его native верхнеуровневый объект (JSON-объект)

ver

Версия Dynamic Native Ads API, которой request соответствует (строка)

imp.native.request

Атрибут
Описание

ver

Версия Native Markup, используемая в данный момент (строка)

context

Контекст, в котором отображается реклама. В данном случае это 1 (Контентно-ориентированный контекст, например лента новостей, статья, галерея изображений, галерея видео или аналогичный), необязательно (целое число)

plcmttype

Дизайн/формат/макет рекламного блока, который предлагается. В настоящее время мы поддерживаем 4 (Виджет рекомендаций) и 500 (Push-уведомление) (целое число)

plcmtcnt

Количество одинаковых размещений в этом макете (целое число)

assets

Массив объектов Asset. Любой ответ на ставку должен соответствовать массиву элементов, указанному в запросе ставки (массив JSON-объектов)

seq

0 для первого объявления, 1 для второго объявления и так далее. Обратите внимание, что это обычно НЕ используется совместно с plcmtcnt — либо вы проводите аукцион для нескольких одинаковых размещений (в этом случае plcmtcnt>1, seq=0), либо вы проводите отдельные аукционы для разных элементов в ленте (в этом случае plcmtcnt=1, seq=>=1)

imp.native.request.assets

Атрибут
Описание

id

Уникальный ID ресурса, назначаемый биржей. Обычно счётчик для массива (целое число)

required

Установите значение 1 если ресурс обязателен или 0 если ресурс необязателен** (целое число)

plcmtcnt

Количество одинаковых размещений в этом макете (целое число)

img

Объект изображения для графических ресурсов* (JSON-объект)

title

Объект заголовка для title-ресурсов* (JSON-объект)

data

Объект данных для названия бренда, описания, оценок, цен и т. д.* (JSON-объект)

video

Видеообъект для видео-ресурсов. См. определение объекта Video request. Обратите внимание, что in-stream (то есть preroll и т. д.) видеореклама не является частью Native. Native-реклама может содержать видео как сам рекламный креатив (объект).

* В каждом объекте ресурса должен присутствовать только один из объектов {img, title, data}

** Ресурсы помечаются как обязательные в соответствии с настройками зоны издателя, где может быть показано ваше объявление

imp.native.request.assets.img

Атрибут
Описание

type

ID типа элемента изображения, поддерживаемого издателем. Мы поддерживаем: 1 (Изображение-иконка) (целое число), 3 (Большой предварительный просмотр изображения для объявления) (целое число)

w

Ширина изображения в пикселях, необязательно (целое число)

h

Высота изображения в пикселях, необязательно (целое число)

wmin

Минимальная требуемая ширина изображения в пикселях (целое число)

hmin

Минимальная требуемая высота изображения в пикселях (целое число)

imp.native.request.assets.title

Атрибут
Описание

len

Максимальная длина текста в элементе заголовка. (целое число)

imp.native.request.assets.video

Атрибут
Описание

mimes

Список поддерживаемых MIME-типов (массив строк).

minduration

Минимальная длительность видеорекламы в секундах (целое число).

maxduration

Максимальная длительность видеорекламы в секундах (целое число).

protocols

Список поддерживаемых протоколов ответа на видеозапрос ставки (массив целых чисел).

linearity

Указывает, должен ли показ быть линейным, нелинейным и т. д. (целое число).

boxingallowed

Указывает, разрешено ли добавление чёрных полей для контента 4:3 в окне 16:9 (целое число).

imp.native.request.assets.data

Атрибут
Описание

type

ID типа элемента, поддерживаемого издателем (целое число). Мы поддерживаем: 1 (sponsored - сообщение «Sponsored By», где ответ должен содержать название бренда спонсора), 2 (desc - описательный текст, связанный с рекламируемым продуктом или услугой)

len

Максимальная длина текста в ответе элемента (целое число)

imp.video

Атрибут
Описание

mimes

Список поддерживаемых MIME-типов (массив строк)

protocols

Список поддерживаемых протоколов ответа на видеозапрос ставки (массив целых чисел)

skip

Указывает, будет ли проигрыватель разрешать пропуск видео, где 0 = нет, 1 = да

skipafter

Количество секунд, которое видео должно проигрываться до включения пропуска; применимо только если рекламу можно пропустить

skipmin

Видео общей длительностью больше этого числа секунд могут быть пропускаемыми; применимо только если рекламу можно пропустить

Если издатель указывает "skip" в запросе, но не "skipafter", видео можно будет пропустить через 5 секунд. В ответе будет установлено значение "skipoffset" = 5. Если издатель указывает "skip", но не "skipmin", видео можно будет пропустить независимо от его длительности.

site

Атрибут
Описание

id*

Уникальный ID сайта (строка)

domain*

Доменное имя сайта (строка)

cat

ID категории IAB (массив строк)

page

Полный URL страницы, где будет показано объявление (строка)

keywords

Ключевые слова можно использовать, чтобы рекламные зоны получали нужный тип рекламы. Ключевые слова должны быть строкой слов, разделённых запятыми

ext

Заполнитель для расширений OpenRTB, специфичных для биржи.

*Эти атрибуты обязательны для форматов Direct Link и Email Clicks.

site.ext

Атрибут
Описание

exchangecat

Пользовательский ID категории ExoClick (целое число)

idzone

Пользовательский ID рекламной зоны ExoClick (целое число)

keyword

Соответствующее ключевое слово, если есть (строка)

Атрибут idzone используется для идентификации источника в ExoClick, откуда поступает трафик.

device

Атрибут
Описание

ua

User-Agent браузера (строка)

sua

Структурированная информация user-agent, которая может использоваться, когда клиент поддерживает User-Agent Client Hints (объект)

geo

Местоположение устройства, которое считается текущим местоположением пользователя, определяемое объектом Geo.

ip

IP-адрес пользователя (строка)*

ipv6

IPv6-адрес пользователя (строка)*

language

Язык браузера в формате ISO-639-1-alpha-2 (строка)

os

Операционная система (строка)

js

Поддержка JavaScript, где 0 = нет, 1 = да (целое число)

ext

Заполнитель для расширений OpenRTB, специфичных для биржи

*В запросе ставки будет присутствовать ровно один из ip или ipv6.

device.geo

Атрибут
Описание

country

Страна ISO3

device.ext

Атрибут
Описание

remote_addr

Основной IP-адрес пользователя (строка)

x_forwarded_for

IP-адрес пользователя из X-FORWARDED-FOR или пусто, если не задан (строка)

device.sua

Структурированная информация User-Agent. device.sua считается более точным представлением атрибутов устройства.

Атрибут
Описание

browsers

Отправляйте бренды и версии, полученные из заголовка Sec-CH-UA-Full-Version-List. (Массив BrandVersion объектов)

platform

Отправляйте бренд, полученный из заголовка Sec-CH-UA-Platform, и версию, полученную из заголовка Sec-CH-UA-Platform-Version. (BrandVersion Объект)

mobile

Получайте это значение из заголовка Sec-CH-UA-Mobile. (целое число)

architecture

Получайте это значение из заголовка Sec-CH-UA-Arch. (строка)

bitness

Получайте это значение из заголовка Sec-CH-UA-Bitness. (строка)

model

Получайте это значение из заголовка Sec-CH-UA-Model. (строка)

source

Источник данных, использованных для создания этого объекта, Список: источник User-Agent в AdCOM 1.0 (целое число; по умолчанию 0)

device.sua.browsers | device.sua.platform

Атрибут
Описание

brand

Значение может быть получено из заголовков User-Agent Client Hints и представлять либо бренд user agent (из заголовка Sec-CH-UA-Full-Version), либо бренд платформы (из заголовка Sec-CH-UA-Platform). (строка)

version

Последовательность компонентов версии в порядке убывания по иерархии [major, minor, micro, …] (массив строк)

user

Атрибут
Описание

id

Уникальный ID пользователя (строка)

ext

Атрибут
Обязательно?
Описание

sub

Нет

sub будет целым числом, представляющим ID зоны, из которой был отправлен запрос.

regs.ext

Атрибут
Описание

dsaapply

Флаг, указывающий, применяется ли DSA к запросу. 1 = обязательно (целое число)

dsa

Расширение для информации о прозрачности DSA (объект)

regs.ext.dsa

Атрибут
Описание

required

Флаг, указывающий, должна ли быть доступна информация DSA. 0 = не требуется, 1 = поддерживается, ответы на ставки с объектом DSA или без него будут приняты, 2 = обязательно, ответы на ставки без объекта DSA не будут приняты, 3 = обязательно, ответы на ставки без объекта DSA не будут приняты, издатель является онлайн-платформой (целое число)

datatopub

Издателю могут понадобиться данные прозрачности для целей аудита. 0 = не отправлять данные прозрачности, 1 = отправка данных прозрачности необязательна, 2 = отправлять данные прозрачности (целое число)

Примеры

Полный список всех типов запросов, которые вы можете получать, вы найдете в нашем Примере страницы запроса рекламодателя.

Последнее обновление

Это было полезно?