bannerType

Получить список типов баннеров.

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

Примечание

Доступна пагинация.

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=bannerType
  & actionObjectID=<integer>

actionObjectID

Чтобы получить данные только по одному типу баннера, укажите его идентификатор.

Значение по умолчанию: 0 — выводить список всех типов баннеров.

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <aliasForID>{integer}</aliasForID>
     <presentationTypeID>{integer}</presentationTypeID>
     <presentationTypeName>{string}</presentationTypeName>
     <isPredefined>{integer}</isPredefined>
     <width>{integer}</width>
     <height>{integer}</height>
     <defaultImageURL>{string}</defaultImageURL>
     <defaultHitURL>{string}</defaultHitURL>
     <defaultCodeType>{integer}</defaultCodeType>
     <defaultCode>{string}</defaultCode>
     <isInvisible>{integer}</isInvisible>
     <isExtension>{integer}</isExtension>
     <dateAdded>{date}</dateAdded>
     <isOn>{integer}</isOn>
    </row0>
</response>

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

code

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

rows

Количество элементов в дереве ответа.

rowN

Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе).

ID

Уникальный идентификатор типа баннера.

name

Название типа баннера.

aliasForID

ID псевдонима.

presentationTypeID

ID типа представления.

Возможные значения:

  • 0 — стандартный;
  • 4 — безразмерный;
  • 5 — XML.ensional.

presentationTypeName

Название типа представления.

isPredefined

Группа для типа баннера.

Возможные значения:

  • 0 — собственные;
  • 1 — предопределенные.

width

Ширина.

height

Высота.

defaultImageURL

URL изображения, указанного для баннера по умолчанию у типа баннера.

defaultHitURL

URL перехода, указанный для баннера по умолчанию у типа баннера.

defaultCodeType

Тип кода для баннера по умолчанию.

Возможные значения:

  • 0 — HTML-код;
  • 1 — JavaScript-код.

defaultCode

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

isInvisible

Для данного типа баннера определен баннер по умолчанию.

dateAdded

Дата добавления типа баннера.

isOn

Тип баннера включен.

Возможные значения:

  • 0 — выключен;
  • 1 — включен.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=bannerType

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>87752</ID>
     <name>example</name>
     <aliasForID>0</aliasForID>
     <presentationTypeID>4</presentationTypeID>
     <presentationTypeName>Безразмерный</presentationTypeName>
     <isPredefined>0</isPredefined>
     <width>0</width>
     <height>0</height>
     <defaultImageURL/>
     <defaultHitURL/>
     <defaultCodeType>0</defaultCodeType>
     <defaultCode/>
     <isInvisible>0</isInvisible>
     <isExtension>0</isExtension>
     <dateAdded>2021-07-23</dateAdded>
     <isOn>1</isOn>
    </row0>
</response>

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

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

Предыдущая
bannerPlaceReport
Следующая
campaign
В этой статье: