template

Получить данные о параметрах шаблона.

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

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

actionObjectID*

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

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

<response>
<status>
  <code>{integer}</code>
</status>
<result>
  <rows>1</rows>
<data>
  <row0>
    <id>{integer}</id>
    <name>{string}</name>
    <ownerID>{integer}</ownerID>
    <description>{string}</description>
    <isZipAllowed>{integer}</isZipAllowed>
    <isLoaderJs>{integer}</isLoaderJs>
    <isMultipleTrackingUrl>{integer}</isMultipleTrackingUrl>
    <isBackgroundColor>{integer}</isBackgroundColor>
    <isWidth>{integer}</isWidth>
    <widthDefault>{integer}</widthDefault>
    <isHeight>{integer}</isHeight>
    <heightDefault>{integer}</heightDefault>
    <isGetUrl>{integer}</isGetUrl>
    <getUrlWidth>{integer}</getUrlWidth>
    <getUrlHeight>{integer}</getUrlHeight>
    <isGetFlv>{integer}</isGetFlv>
    <isImageUrl>{integer}</isImageUrl>
    <imageUrlWidth>{integer}</imageUrlWidth>
    <imageUrlHeight>{integer}</imageUrlHeight>
    <isHitUrl>{integer}</isHitUrl>
    <isTarget>{integer}</isTarget>
    <isAlt>{integer}</isAlt>
    <isFlashParameterName>{integer}</isFlashParameterName>
    <isTargetParameterName>{integer}</isTargetParameterName>
    <isTrackingUrl>{integer}</isTrackingUrl>
    <codeType>{integer}</codeType>
    <impressionCode>{string}</impressionCode>
    <markingSettings>{integer}</markingSettings>
    <isIms>{integer}</isIms>
    <userParameters>
      <row0>
        <userParameterId>{integer}</userParameterId>
        <isOn>{integer}</isOn>
        <name>{string}</name>
        <isRequired>{integer}</isRequired>
        <type>{string}</type>
        <length>{integer}</length>
        <default>{string}</default>
        <fileTypeId>{integer}</fileTypeId>
        <width>{string}</width>
        <height>{string}</height>
        <upload_domain>{string}</upload_domain>
      </row0>
       ...
      <row24>
        ...
      </row24>
    </userParameters>
      <events>
        <row0>
          <eventId>{integer}</eventId>
          <name>{string}</name>
          <limitSession>{integer}</limitSession>
        </row0>
          ...
        <row29>
          ...
        </row29>
      </events>
    <templateCreatives>
      <row0>
        <field>{string}</field>
        <type>{string}</type>
      </row0>
      <row1>
        <field>{string}</field>
        <type>{string}</type>
      </row1>
      <rowN>
       ...
      </rowN>
    </templateCreatives>
      </row0>
</data>
</result>
</response>

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

code

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

row0

Элемент списка с соответствующим номером.

row0

Элемент списка с соответствующим номером.

ID

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

name

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

ownerID

ID аккаунта.

description

Описание шаблона.

isZipAllowed

Разрешена загрузка архивов.

isLoaderJs

Шаблон работает на кодах вставки с загрузчиком.

isMultipleTrackingUrl

Добавление нескольких промерочных пикселей.

isBackgroundColor

Включена переменная «Цвет фона».

isWidth

Включена переменная «Ширина».

widthDefault

Задано значение ширины баннера.

isHeight

Включена переменная «Высота».

heightDefault

Задано значение высоты баннера.

isGetUrl

Включена переменная «Flash-ролик».

getUrlWidth

Задано значение ширины для flash-ролика.

getUrlHeight

Задано значение высоты для flash-ролика.

isGetFlv

Включена переменная «FLV-ролик».

isImageUrl

Включена переменная «Изображение».

imageUrlWidth

Задано значение ширины для изображения.

imageUrlHeight

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

isHitUrl

Включена переменная «URL перехода».

isTarget

Включена переменная «TARGET ссылки».

isAlt

Включена переменная «ALT изображения».

isFlashParameterName

Включена переменная «Параметр передачи перехода».

isTargetParameterName

Включена переменная «Параметр передачи target».

isTrackingUrl

Включена переменная «Ссылка на промерочный пиксель».

codeType

Тип кода шаблона.

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

  • 0 — HTML;
  • 1 — JavaScript.

impressionCode

Код шаблона.

markingSettings

Включен раздел «метка Реклама» для настройки метки при создании баннера.

isIms

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

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

userParameters

Дополнительные переменные от 1 до 25.

userParameterId

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

isOn

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

name

Название дополнительной переменной.

isRequired

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

type

Тип дополнительной переменной.

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

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

length

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

default

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

fileTypeId

Тип файла дополнительной переменной.

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

  • 0 — не задан;
  • 1 — картинка;
  • 2 — flash;
  • 3 — flv.

width

Ширина для файла дополнительной переменной.

height

Высота для файла дополнительной переменной.

upload_domain

Домен для загрузки файлов к дополнительной переменной.

events

События от 1 до 30.

templateCreatives.rowN.field

Параметр баннера, значение которого может использоваться в качестве креатива.

templateCreatives.rowN.type

Тип креатива:

  • creativeTextData — значение параметра будет отправляться в ЕРИР в качестве текстового поля.
  • creativeMediaData — значение параметра будет отправляться в ЕРИР в виде ссылки на креатив. Перед сохранением файла выполняется проверка URL на доступность файла.

eventId

Идентификатор события.

name

Название события.

limitSession

Ограничение на сессию.

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

Запрос:

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

Ответ:

<response>
<status>
  <code>0</code>
</status>
<result>
  <rows>1</rows>
<data>
  <row0>
    <id>119742</id>
    <name>Banner HTML5 [context] копия 1</name>
    <ownerID>392990</ownerID>
    <description/>
    <isZipAllowed>1</isZipAllowed>
    <isLoaderJs>1</isLoaderJs>
    <isMultipleTrackingUrl/>
    <isBackgroundColor/>
    <isWidth>1</isWidth>
    <widthDefault/>
    <isHeight>1</isHeight>
    <heightDefault/>
    <isGetUrl>0</isGetUrl>
    <getUrlWidth/>
    <getUrlHeight/>
    <isGetFlv>1</isGetFlv>
    <isImageUrl>1</isImageUrl>
    <imageUrlWidth>0</imageUrlWidth>
    <imageUrlHeight>0</imageUrlHeight>
    <isHitUrl>1</isHitUrl>
    <isTarget>1</isTarget>
    <isAlt>0</isAlt>
    <isFlashParameterName>0</isFlashParameterName>
    <isTargetParameterName>0</isTargetParameterName>
    <isTrackingUrl>1</isTrackingUrl>
    <codeType>2</codeType>
    <impressionCode>global.banner_html_json</impressionCode>
    <markingSettings>1</markingSettings>
    <isIms>1</isIms>
    <userParameters>
      <row0>
        <userParameterId>1</userParameterId>
        <isOn>1</isOn>
        <name>URL перехода</name>
        <isRequired>0</isRequired>
        <type/>
        <length>0</length>
        <default/>
        <fileTypeId>0</fileTypeId>
        <width/>
        <height/>
        <upload_domain/>
      </row0>
       ...
      <row24>
        ...
      </row24>
    </userParameters>
      <events>
        <row0>
          <eventId>123</eventId>
          <name>Сайт</name>
          <limitSession>1</limitSession>
        </row0>
          ...
        <row29>
          ...
        </row29>
      </events>
    <templateCreatives>
      <row0>
        <field>imageURL</field>
        <type>creativeMediaData</type>
      </row0>
      <row1>
        <field>user1</field>
        <type>creativeTextData</type>
      </row1>
      <rowN>
       ...
      </rowN>
    </templateCreatives>
      </row0>
</data>
</result>
</response>

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

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

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

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

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