template

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

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

Примечание

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

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

objectID*

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

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

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

<response>
  <status>
   <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <templateID>{integer}</templateID>
     <templateName>{string}</templateName>
     <isSystem>{integer}</isSystem>
     <isIms>{integer}</isIms>
    </row0>
</response>

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

code

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

rows

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

rowN

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

templateID

Идентификатор шаблона.

templateName

Название шаблона.

isSystem

Тип шаблона.

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

  • 0 — пользовательский;
  • 1 — системный.

isIms

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

  • 0 — шаблон не содержит ims событий. Подходит для создания баннеров в кампаниях с методиками посчета показов, отличными от IMS;
  • 1 — шаблон поддерживает ims события и с таким шаблоном можно создавать баннеры в кампаниях с ims-методиками учета показов.

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

Запрос:

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

Ответ:

<response>
    <status>
        <code>0</code>
    </status>
    <result>
        <rows>9</rows>
        <data>
            <row0>
                <templateID>117875</templateID>
                <templateName>Banner HTML5 [context]</templateName>
                <isSystem>0</isSystem>
                <isIms>1</isIms>
            </row0>
            ...
        </data>
    </result>
</response>

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

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

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