Direct API

Endpoint для прямых запросов рекламы по placement. Поддержка Banner (iframe), Outstream и Instream для WEB и APP.

Base URL

https://ia.box/ads/direct

WEB

Запрос рекламы для сайта.

GET https://ia.box/ads/direct?plc=test_banner&referer=iabox.uz

Параметры

Параметр	Обязательный	Описание
`plc`	Да	Название placement
`referer`	Нет	Переопределение домена (site referer)

Пример

GET https://ia.box/ads/direct?plc=test_banner&referer=iabox.uz

APP

Запрос рекламы для мобильного приложения.

GET https://ia.box/ads/direct?plc=test_banner&bundle=test.com&ifa=user_device_id

Параметры

Параметр	Обязательный	Описание
`plc`	Да	Название placement
`bundle`	Нет	Переопределение App Bundle ID
`ifa`	Нет	Переопределение Device ID (IDFA / GAID)

Пример

GET https://ia.box/ads/direct?plc=test_banner&bundle=test.com&ifa=user_device_id

Banner (iframe) — WEB

Встраивание баннерной рекламы через iframe. Только для сайтов.

<iframe
    src="https://ia.box/ads/direct?plc=test_banner&referer=dsp-ui.uz"
    width="100%"
    height="600"
    frameborder="0"
    allowfullscreen
></iframe>

URL-параметры

Параметр	Обязательный	Описание
`plc`	Да	Название placement
`referer`	Нет	Переопределение домена (site referer)

Атрибуты iframe

Атрибут	Описание	Пример
`width`	Ширина баннера	`100%`
`height`	Высота баннера (px)	`600`
`frameborder`	Рамка фрейма	`0`
`allowfullscreen`	Разрешить полноэкранный режим	—

Outstream (Video) — WEB

Встраиваемый скрипт для видеорекламы. Только для сайтов.

<script src="https://storage.dsp-ui.uz/uploads/outstream.js"
    adunit-id="test"
    referer="iabox.uz"
    width="300"
    height="600">
</script>

Атрибуты

Атрибут	Обязательный	Описание	По умолчанию
`adunit-id`	Да	Название placement (adunit ID)	—
`referer`	Нет	Переопределение домена (referer)	—
`width`	Нет	Ширина плеера (px)	`640`
`height`	Нет	Высота плеера (px)	`360`

Если передан referer, он будет добавлен к URL запроса Direct API.

Сгенерированный URL

# С referer:
https://ia.box/ads/direct?plc=test&referer=iabox.uz

# Без referer:
https://ia.box/ads/direct?plc=test

Instream (Video) — APP

Встраивание видеорекламы в мобильное приложение. Только для APP.

Работает через Google IMA SDK

Instream-реклама доставляется через Google Interactive Media Ads (IMA) SDK. Direct API возвращает VAST-ответ, который необходимо передать в IMA SDK для воспроизведения.

Документация Google IMA SDK →

URL запроса:

GET https://ia.box/ads/direct?plc=test_banner&bundle=test.com&ifa=user_device_id

Параметры

Параметр	Обязательный	Описание
`plc`	Да	Название placement
`bundle`	Нет	Переопределение App Bundle ID
`ifa`	Нет	Переопределение Device ID (IDFA / GAID)

Пример

# С переопределениями:
https://ia.box/ads/direct?plc=test_banner&bundle=test.com&ifa=user_device_id

# Минимальный:
https://ia.box/ads/direct?plc=test_banner

Summary

Интеграция	Платформа	Формат
Banner (iframe)	WEB	Banner
Outstream	WEB	Video
Instream	APP	Video

Параметры по платформам

Параметр	WEB	APP
`plc`	Да	Да
`referer`	Нет	Нет
`bundle`	Нет	Нет
`ifa`	Нет	Нет