template

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

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=list
 & actionObject=template
 & [actionObjectID=<integer>]
Query-параметры
actionObjectID

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

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

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

<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>
      <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>
     </row0>
    </data>
   </result>
</response>

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

rows

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

rowN

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

ID

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

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

ID аккаунта.

description

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

isZipAllowed

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

isLoaderJs
Шаблон работает на кодах вставки с библиотекой loader.js.
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

Код шаблона.

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.

eventId

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

name

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

limitSession

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

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=template&actionObjectID=4256

Ответ:

<response>
<status>
<code>0</code>
</status>
<result>
<rows>1</rows>
<data>
<row0>
<id>43321</id>
<name>FullScreen HTML [Sync_Async]</name>
<ownerID>218645</ownerID>
<description>Фуллскрин</description>
<isZipAllowed/>
<isLoaderJs/>
<isMultipleTrackingUrl/>
<isBackgroundColor>1</isBackgroundColor>
<isWidth>1</isWidth>
<widthDefault>1000</widthDefault>
<isHeight>1</isHeight>
<heightDefault>50</heightDefault>
<isGetUrl>1</isGetUrl>
<getUrlWidth>222</getUrlWidth>
<getUrlHeight>22</getUrlHeight>
<isGetFlv>1</isGetFlv>
<isImageUrl>1</isImageUrl>
<imageUrlWidth>400</imageUrlWidth>
<imageUrlHeight>400</imageUrlHeight>
<isHitUrl>1</isHitUrl>
<isTarget>1</isTarget>
<isAlt>1</isAlt>
<isFlashParameterName>1</isFlashParameterName>
<isTargetParameterName>1</isTargetParameterName>
<isTrackingUrl>1</isTrackingUrl>
<codeType>1</codeType>
<impressionCode>%global.fullscreenHTML%</impressionCode>
<userParameters>
<row0>
<userParameterId>1</userParameterId>
<isOn>1</isOn>
<name>URL перехода</name>
<isRequired/>
<type>string</type>
<length>0</length>
<default/>
<fileTypeId>0</fileTypeId>
<width/>
<height/>
<upload_domain/>
</row0>
...
</userParameters>
<events>
<row0>
<eventId>1</eventId>
<name/>
<limitSession>0</limitSession>
</row0>
...
</events>
</row0>
</data>
</result>
</response>