updateDefaultBanner

Добавить баннер по умолчанию на уровне типа баннера. Баннер по умолчанию — это код баннера, который показывается пользователю, если в этот момент нельзя показать ни одного баннера из коммерческих рекламных кампаний.

Баннеры по умолчанию можно задавать на уровне площадки и/или типа баннера.

Если для площадки код баннера по умолчанию не задан, то будет показан код баннера по умолчанию, заданный для типа баннера. Если для типа баннера также не задан код по умолчанию, то в ответ на запрос сервер вернет системную заглушку, не влияющую на отображение рекламной площадки на сайте.

Формат запроса

https://adfox.yandex.ru/api/v1
  ? object=bannerType
  & action=updateDefaultBanner
  & objectID=<integer>
  & mode=<integer>
  & [defaultImageURL=<string>]
  & [defaultHitURL=<string>]
  & [defaultWidth=<integer>]
  & [defaultHeight=<integer>]
  & [defaultCode=<string>]
  & [defaultCodeType=<integer>]

objectID*

ID объекта, над которым производится действие.

mode*

Режим для вставки баннера по умолчанию.

Допустимые значения:

  • 0 — файл (только для стандартных и безразмерных типов баннеров);
  • 1 — код.

Значение по умолчанию: 0.

defaultImageURL

Только для mode=0 и типа баннера: стандартный и безразмерный.

URL изображения баннера по умолчанию.

Если указан defaultImageURL, параметр «URL перехода» (defaultHitURL) становится обязательным.

defaultHitURL

Только для mode=0 и типа баннера: стандартный и безразмерный.

Укажите URL для перехода с баннера по умолчанию.

defaultWidth

Только для mode=0 и типа баннера: безразмерный.

Ширина изображения в пикселях.

defaultHeight

Только для mode=0 и типа баннера: безразмерный.

Высота изображения в пикселях.

defaultCode

Только для mode=1 и типа баннера: безразмерный.

Код баннера по умолчанию.

defaultCodeType

Только для mode=1.

Тип кода.

Допустимые значения:

  • 0 — HTML;
  • 1 — JavaScript.

Значение по умолчанию: 0.

* Обязательный параметр

Формат ответа

<response>
<status>
  <code>{integer}</code>
</status>
</response>

Параметры ответа

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=bannerType&action=updateDefaultBanner&objectID=234&mode=0

Ответ:

<response>
<status>
  <code>0</code>
</status>
</response>

Другие действия с объектом

Читайте также о других действиях с объектом bannerType:

Предыдущая
Следующая