Запрос ставки Open RTB 2.4
На этой странице объясняется, как отправлять запросы на ставки
Заголовки запроса ставки
HTTP-заголовок версии OpenRTB:
x-openrtb-version: 2.4HTTP-заголовок Keep-Alive:
Connection: Keep-AliveJSON-содержимое:
Content-Type: application/json
Следующие объекты следует отправлять, закодировав их как JSON в теле запроса:
Запрос ставки
в
Да
Тип аукциона, первая цена = 1 (целое число)
id
Да
Уникальный ID запроса ставки (строка)
imp
Да
Массив объектов Imp, представляющих предлагаемые показы (объект).
site
Да
Сведения об веб-сайте издателя через объект Site (объект).
приложение
Да
Сведения об приложении издателя* через объект App (объект).
device
Да
Сведения об устройстве пользователя, которому будет показан показ, через объект Device (объект).
user
Нет
Сведения о человеке-пользователе устройства; рекламная аудитория (объект).
ext
Нет
Заглушка для расширений OpenRTB.
imp
id
Да
Уникальный ID показа в этом запросе ставки (строка)
bidfloor
Нет
Минимальная ставка за этот показ (CPM) / клик (CPC) и валюта аккаунта (float)
bidfloorcur
Нет
Валюта для значения минимальной ставки, указанная с использованием буквенных кодов ISO-4217 (string)
native
Только для native- и push-показов
Возможность объекта Native (объект).
banner
Только для баннерных и полноэкранных межстраничных показов
Возможность объекта Banner (объект).
instl
Только для pop-, direct link-, email- и полноэкранных межстраничных кликовых показов
Возможность объекта Fullscreen (объект).
video
Только для видео
Возможность объекта Video (объект)
secure
Рекомендуется
Флаг, указывающий, требуется ли для показа защищённый HTTPS URL для креативных материалов и разметки: 0 = небезопасно, 1 = безопасно (рекомендуется). Если не указан, состояние защищённости неизвестно, но можно предположить поддержку небезопасного HTTP (integer)
el
Нет
Электронная почта, закодированная в Base64 (строка)
ext
Нет
Заглушка для расширений, специфичных для биржи
imp.banner
w
Да
Ширина баннера (integer)
h
Да
Высота баннера (integer)
mimes
Нет
Список поддерживаемых типов MIME (массив строк). Поддерживаются: image/jpeg, image/jpg, image/png, image/png, image/gif, image/webp, video/mp4
ext
Нет
Заглушка для расширений, специфичных для биржи (объект)
imp.banner.ext
image_output
Нет
Указывает формат вывода для изображений баннеров* (string)
video_output
Нет
Указывает формат вывода для видео-баннеров* (string)
*Определяет формат поля adm для баннерного формата. Варианты: xml или html. Значение по умолчанию — xml, если поле не указано.
imp.instl
instl
Да
0 = клики по прямой ссылке/электронной почте, 1 = popunder/полноэкранный межстраничный
imp.native (для Native и Push Notification Ads)
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
Нет
Количество одинаковых размещений в этом макете. Макс.: 10 (integer) (integer)
assets
Да
Массив объектов Asset. Любой ответ на ставку должен соответствовать массиву элементов, указанному в запросе ставки (массив JSON-объектов)
seq
Нет
0 для первого объявления, 1 для второго объявления и так далее. Обратите внимание, что это обычно НЕ используется совместно с plcmtcnt — либо вы проводите аукцион для нескольких одинаковых размещений (в этом случае plcmtcnt>1, seq=0), либо вы проводите отдельные аукционы для разных элементов в ленте (в этом случае plcmtcnt=1, seq=>=1)
imp.native.request.assets
id
Да
Уникальный ID ресурса, назначаемый биржей. Обычно счётчик для массива (integer) 1: ID ресурса изображения, 2: ID ресурса заголовка, 3: ID ресурса описания
required
Нет
Установите значение 1 если ресурс обязателен или 0 если ресурс необязателен (integer)
plcmtcnt
Нет
Количество одинаковых размещений в этом макете (целое число)
img
Да
Объект Image для ресурсов изображений** (JSON object)
title
Нет
Объект Title для ресурсов заголовка** (JSON object)
data
Нет
Объект данных для названия бренда, описания, оценок, цен и т. д.* (JSON-объект)
*Количество полученных ставок для вашего Native-запроса будет основано на значении, которое вы установите в "plcmtcnt". Например, запрос ставки с "plcmtcnt":3 получит 3 разных объекта ставки. Вы можете найти пример этого на странице странице с примером ответа.
** Только один из объектов {img, title, data} должен присутствовать в каждом объекте ресурса
imp.native.request.assets.img
type
Нет
ID типа элемента изображения, поддерживаемого издателем. Мы поддерживаем: 1 (Изображение-иконка) (целое число), 3 (Большой предварительный просмотр изображения для объявления) (целое число)
w
Нет
Ширина изображения в пикселях, необязательно (целое число)
h
Нет
Высота изображения в пикселях, необязательно (целое число)
wmin
Да
Минимальная требуемая ширина изображения в пикселях (целое число)
hmin
Да
Минимальная требуемая высота изображения в пикселях (целое число)
*Размеры значка Push Notification: 192px x 192px
imp.native.request.assets.title
len
Да
Максимальная длина текста в элементе заголовка. (целое число)
imp.native.request.assets.data
type
Да
ID типа элемента, поддерживаемого издателем (целое число). Мы поддерживаем: 1 (sponsored - сообщение «Sponsored By», где ответ должен содержать название бренда спонсора), 2 (desc - описательный текст, связанный с рекламируемым продуктом или услугой)
len
Нет
Максимальная длина текста в ответе элемента (целое число)
imp.video
mimes
Нет
Список поддерживаемых MIME-типов (массив строк)
protocols
Нет
Список поддерживаемых протоколов ответа на видеозапрос ставки (массив целых чисел)
skip
Нет
Указывает, будет ли проигрыватель разрешать пропуск видео, где 0 = нет, 1 = да
skipafter
Нет
Количество секунд, которое видео должно проигрываться до включения пропуска; применимо только если рекламу можно пропустить
skipmin
Нет
Видео общей длительностью больше этого числа секунд могут быть пропускаемыми; применимо только если рекламу можно пропустить
imp.ext
video_cta
Нет
Указывает, следует ли предоставлять CTA: 0 = нет, 1 = да (по умолчанию 1)
Чтобы увидеть пример CTA, ознакомьтесь с нашим странице с примером ответа.
site
id
Обязательно
Уникальный ID сайта (строка)
domain
Обязательно
Доменное имя сайта (строка)
имя
Обязательно
Название сайта (string)
cat
Нет
ID категории IAB (массив строк)
page
Рекомендуется
Полный URL страницы, где будет показано объявление (строка)
keywords
Нет
Ключевые слова можно использовать, чтобы гарантировать, что рекламные зоны получают нужный тип рекламы. Ключевые слова должны представлять собой строку слов, разделённых запятыми.
ext
Нет
Заполнитель для расширений OpenRTB, специфичных для биржи.
site.ext
exchangecat
Нет
Пользовательский ID категории ExoClick (целое число)
idzone
Нет
Пользовательский ID рекламной зоны ExoClick (целое число)
приложение
id
Обязательно
Уникальный ID приложения (string)
cat
Нет
ID категории IAB (массив строк)
keywords
Нет
Ключевые слова можно использовать, чтобы гарантировать, что рекламные зоны получают нужный тип рекламы. Ключевые слова должны представлять собой строку слов, разделённых запятыми (string)
издатель
Нет
Сведения об издателе (объект)
app.publisher
domain
Рекомендуется
Домен верхнего уровня издателя (например, "publisher.com") (string)
device
ua
Да
User-Agent браузера (строка)
geo
Нет
Местоположение устройства, которое считается текущим местоположением пользователя, определяемое объектом Geo.
ip
Да
IP-адрес пользователя (строка)*
ipv6
Рекомендуется
IPv6-адрес пользователя (строка)*
language
Рекомендуется
Язык браузера в формате ISO-639-1-alpha-2 (строка)
os
Нет
Операционная система (строка)
js
Нет
Поддержка JavaScript, где 0 = нет, 1 = да (целое число)
ext
Нет
Заполнитель для расширений OpenRTB, специфичных для биржи
device.geo
country
Нет
Страна ISO3
device.ext
remote_addr
Нет
Основной IP-адрес пользователя (строка)
x_forwarded_for
Нет
IP-адрес пользователя из X-FORWARDED-FOR или пусто, если не задан (строка)
user
id
Да
Уникальный ID пользователя (строка)
ext
sub
Нет
Sub ID. Это должно быть число длиной от одной до десяти цифр: не используйте нули в начале Sub ID.
экспорт
Нет
Тип ответа может быть "json" или "xml" (string). По умолчанию — "json".
Примеры
Вы можете найти подробный список примеров запросов в нашем странице с примерами
Последнее обновление
Это было полезно?