Получение рекламных форматов

Запрос рекламных креативов по идентификатору плейсмента (padId).

Endpoint

GET /v1/ads/get

Параметры

Параметр Тип Обязательный Описание
padId integer Да Идентификатор рекламного плейсмента
userId string Нет Ваш идентификатор пользователя

Пример запроса

curl -X GET "https://[API_BASE_URL]/v1/ads/get?padId=YOUR_PAD_ID"

Ответ

Общая структура ответа API для всех рекламных форматов одинаковая. Отличаются только templateGroupName, набор пикселей и модели Creative (зависят от формата плейсмента). См. Модели данных и Рекламные форматы.

Поле Тип Описание
padId Int Id рекламного плейсмента
templateGroupName String Формат: modalwindow, multiformat, stories, clickout — см. Рекламные форматы
templateName String Имя шаблона, реализующего UI отображение
displayOptions DisplayOptions UI-конфигурация (зависит от формата)
items [Creative] Массив креативов: разный для каждого формата
statistics [Statistic] Пиксели для всего блока

Структура displayOptions и Creative зависит от templateGroupName. См. Рекламные форматы.

Коды ответа

Код Описание
200 Реклама найдена
204 Нет рекламы для показа
400 Неверные параметры

Обработка ошибок

  1. Установите таймаут для ожидания ответа от сервера.
  2. Если полученный ответ имеет статус, отличный от 200, выполните одно из следующих действий:
  • Не отображайте ничего.
  • Отобразите заглушку, например, стандартный баннер