Запрос ставки Open RTB 2.5

Эта страница объясняет, как делать запросы на ставки.

Рекомендуемые заголовки запроса ставки

• HTTP-заголовок версии OpenRTB: x-openrtb-version: 2.5
• HTTP-заголовок Keep-Alive: Connection: Keep-Alive
• JSON-содержимое: Content-Type: application/json

Следующие объекты должны быть отправлены в теле запроса в кодировке JSON:

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

Атрибут	Обязательно?	Описание
в	Да	Тип аукциона, первая цена = 1 (целое число)
id	Да	Уникальный ID запроса ставки (строка)
imp	Да	Массив объектов Imp, представляющих предлагаемые показы (объект).
site	Да	Сведения о сайте издателя (объект).
app	Да	Сведения о приложении издателя (объект).
device	Да	Сведения об устройстве пользователя, на которое будет доставлен показ (объект).
user	Нет	Сведения о человеке-пользователе устройства; рекламная аудитория (объект).
ext	Нет	Заполнитель для расширений OpenRTB.

Только один из объектов {site, app} должен присутствовать в каждом запросе.

imp

Атрибут	Обязательно?	Описание
id	Да	Уникальный ID показа в этом запросе ставки (строка)
bidfloor	Нет	Минимальная ставка для этого показа (CPM) / клика (CPC) и валюта аккаунта (float).
banner	Только для полностраничных показов	Объект баннера (объект).
secure	Нет; рекомендуется 1	Флаг, указывающий, требует ли показ защищённых HTTPS URL-ресурсов креатива и разметки, где 0 = небезопасно, 1 = безопасно. Если не указан, состояние безопасности неизвестно, но можно предположить поддержку небезопасного HTTP, необязательно (целое число)

imp.banner

Атрибут	Обязательно?	Описание
w	Да	Ширина баннера (целое число)
h	Да	Высота баннера (целое число)
mimes	Да	Типы MIME - image/jpg, image/png, video/mp4 или image/webp

imp.video

Атрибут	Обязательно?	Описание
mimes	Да	Поддерживаемые типы MIME содержимого (например, "video/mp4") (массив строк)
minduration	Нет	Минимальная длительность видеорекламы в секундах (целое число)
maxduration	Нет	Максимальная длительность видеорекламы в секундах (целое число)
protocols	Нет	Массив поддерживаемых видеопротоколов (целое число)
linearity	Нет	Указывает, должен ли показ быть линейным, нелинейным и т. д. Если ничего не указано, считать, что разрешены все варианты (целое число)
boxingallowed	Нет	Указывает, разрешено ли размещение контента 4:3 в окне 16:9 с чёрными полями, где 0 = нет, 1 = да (целое число)
pos	Нет	Позиция рекламы на экране (целое число)
h	Нет	Ширина видеоплеера в независимых от устройства пикселях (DIPS) (целое число)
w	Нет	Высота видеоплеера в независимых от устройства пикселях (DIPS) (целое число)
ext	Нет	Заполнитель для расширений OpenRTB, специфичных для биржи (объект)

imp.video.ext

Атрибут	Обязательно?	Описание
zone_type	Нет	Тип зоны в рекламных форматах ExoClick (например: video_slider)
cta	Нет	Указывает, отображает ли рекламная зона компонент CTA (целое число)

site

Атрибут	Обязательно?	Описание
id	Рекомендуется	Уникальный ID сайта (строка)
name	Нет	Название сайта (строка)
domain	Рекомендуется	Доменное имя сайта (строка)
cat	Нет	ID категории IAB (массив строк)
page	Рекомендуется	Полный URL страницы, где будет показано объявление (строка)
keywords	Нет	Ключевые слова можно использовать, чтобы рекламные зоны получали нужный тип рекламы. Ключевые слова должны быть строкой слов, разделённых запятыми

site.ext

Атрибут	Обязательно?	Описание
exchangecat	Нет	Пользовательский ID категории ExoClick (целое число)
idzone	Нет	Пользовательский ID зоны ExoClick (целое число)

app

Атрибут	Обязательно?	Описание
id	Рекомендуется	Уникальный ID приложения (строка)
name	Нет	Название приложения (строка)
domain	Рекомендуется	Доменное имя приложения (строка)
cat	Нет	ID категории IAB (массив строк)
keywords	Нет	Ключевые слова можно использовать, чтобы рекламные зоны получали правильный тип рекламы. Ключевые слова должны быть строкой слов, разделённых запятыми (строка)
publisher	Нет	Сведения об издателе (объект)

device

Атрибут	Обязательно?	Описание
ua	Да	User-Agent браузера (строка)
sua	Нет	Структурированная информация user-agent, которая может использоваться, когда клиент поддерживает User-Agent Client Hints (объект)
geo	Нет	Местоположение устройства, которое считается текущим местоположением пользователя, определяемое объектом Geo.
ip	Да	IPv4-адрес пользователя (строка)*
ipv6	Да	IPv6-адрес пользователя (строка)*
language	Рекомендуется	Язык браузера (строка)
os	Нет	Операционная система (строка)
js	Нет	Поддержка JavaScript, где 0 = нет, 1 = да (целое число)
ext	Нет	Заполнитель для расширений OpenRTB, специфичных для биржи

В запросе нужно указывать только ip или ipv6, но не оба сразу. Если используете ipv6, удалите атрибут ip, и наоборот. Указание обоих может привести к ошибкам.

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	Нет	Заполнитель для расширений OpenRTB, специфичных для биржи (объект)

user.ext

Атрибут	Обязательно?	Описание
согласие	Нет	Это строка согласия, требуемая стандартами IAB. Пока только отрицательное согласие (строка)

regs

Атрибут	Обязательно?	Описание
ext	Нет	Заполнитель для расширений OpenRTB, специфичных для биржи (объект)

regs.ext

Атрибут	Обязательно?	Описание
GDPR	Нет	Это 0, если вызывающая сторона считает, что пользователь не подпадает под GDPR, и 1, если пользователь подпадает под GDPR. Если ни то ни другое, этот параметр будет неопределён.

ext

Атрибут	Обязательно?	Описание
sub	Нет	Sub ID. Это должно быть число от одной до десяти цифр: не используйте нули в начале Sub ID.