bannerFields

Получить список пользовательских полей, определенных в шаблоне баннера.

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

https://adfox.yandex.ru/api/v1
  ? object=banner
  & action=info
  & actionObject=bannerFields
  & objectID=<integer>
  & additionalID=<integer>

objectID*

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

additionalID*

ID шаблона баннера.

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

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

 <response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <row0>
    <dataType>{string}</dataType>
    <name>{string}</name>
    <length>{string}</length>
    <inputType>{string}</inputType>
    <isRequired>{integer}</isRequired>
    <status>{string}</status>
    <defaultValue>{string}</defaultValue>
    <allowedTypes>{string}</allowedTypes>
    <width>{string}</width>
    <height>{string}</height>
   </row0>
</response>

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

code

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

ID

Идентификатор новой кампании/флайта.

ID

Идентификатор новой кампании/флайта.

dataType

Тип переменной.

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

  • PredefinedParameters — предопределенная переменная, созданная в системе и уже имеющая название и свойства (длина значения, тип данных). Чтобы использовать переменную в шаблоне, достаточно включить переменную и подставить ее имя в код шаблона;
  • userParameters — дополнительная переменная, созданная пользователем системы. Чтобы использовать переменную в шаблоне, необходимо указать название и свойства (длина значения, тип данных, обязательность, значение по умолчанию) и подставить имя переменной в код шаблона.

name

Наименование переменной в коде.

length

Длина поля для значения переменной.

inputType

Тип данных.

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

  • textarea — текст;
  • text — строка;
  • file — файл.

isRequired

Обязательность заполнения переменной.

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

  • 0 — необязательная переменная;
  • 1 — обязательная переменная.

status

Включить значение по умолчанию для предопределенной переменной.

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

  • 0 — не задано;
  • checked — использовать значение по умолчанию.

defaultValue

Включить значение по умолчанию для дополнительной переменной.

allowedTypes

Разрешенный тип файла для дополнительной переменной.

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

  • 0 — не задано;
  • .gif|.png|.jpg — картинка;
  • .swf — flash;
  • .flv — видео.

width

Ширина для изображения.

height

Высота для изображения.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=banner&action=info&actionObject=bannerFields&objectID=474205&additionalID=23

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <row0>
    <dataType>PredefinedParameters</dataType>
    <name>trackingURL</name>
    <length/>
    <inputType>text</inputType>
    <isRequired/>
    <status/>
    <defaultValue/>
    <allowedTypes/>
    <width/>
    <height/>
   </row0>
</response>

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

ID шаблона баннера.

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

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