template
Получить данные о параметрах шаблона.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=template
& actionObjectID=<integer>
|
Укажите идентификатор шаблона. |
* Обязательный параметр
Формат ответа
<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>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Элемент списка с соответствующим номером. |
|
Элемент списка с соответствующим номером. |
|
Уникальный идентификатор шаблона. |
|
Название шаблона. |
|
ID аккаунта. |
|
Описание шаблона. |
|
Разрешена загрузка архивов. |
|
Шаблон работает на кодах вставки с загрузчиком. |
|
Добавление нескольких промерочных пикселей. |
|
Включена переменная «Цвет фона». |
|
Включена переменная «Ширина». |
|
Задано значение ширины баннера. |
|
Включена переменная «Высота». |
|
Задано значение высоты баннера. |
|
Включена переменная «Flash-ролик». |
|
Задано значение ширины для flash-ролика. |
|
Задано значение высоты для flash-ролика. |
|
Включена переменная «FLV-ролик». |
|
Включена переменная «Изображение». |
|
Задано значение ширины для изображения. |
|
Задано значение высоты для изображения. |
|
Включена переменная «URL перехода». |
|
Включена переменная «TARGET ссылки». |
|
Включена переменная «ALT изображения». |
|
Включена переменная «Параметр передачи перехода». |
|
Включена переменная «Параметр передачи target». |
|
Включена переменная «Ссылка на промерочный пиксель». |
|
Тип кода шаблона: 0 — HTML, 1 — JavaScript. |
|
Код шаблона. |
|
Включен раздел «метка Реклама» для настройки метки при создании баннера. |
|
Возможные значения:
|
|
Дополнительные переменные от 1 до 25. |
|
Идентификатор дополнительной переменной. |
|
Включена дополнительная переменная. |
|
Название дополнительной переменной. |
|
Обязательное указание значения дополнительной переменной. |
|
Тип дополнительной переменной: string — Строка, text — Текст, file — Файл. |
|
Длина значения дополнительной переменной. |
|
Значение по умолчанию для дополнительной переменной. |
|
Тип файла дополнительной переменной: 0 — не задан, 1 — картинка, 2 — flash, 3 — flv. |
|
Ширина для файла дополнительной переменной. |
|
Высота для файла дополнительной переменной. |
|
Домен для загрузки файлов к дополнительной переменной. |
|
События от 1 до 30. |
|
Параметр баннера, значение которого может использоваться в качестве креатива. |
|
Тип креатива:
|
|
Идентификатор события. |
|
Название события. |
|
Ограничение на сессию. |
Пример запроса и ответа
Запрос:
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
:
Укажите идентификатор шаблона.
Обязательный параметр