banner

Добавить баннер.

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=add
 & actionObject=banner
 & campaignID=<integer>
 & [name=<string>]
 & [targetingProfileID=<integer>]
 & [templateID=<integer>]
 & [bannerTypeID=<integer>]
 & contentType=<string>
 & [priority=<integer>]
 & [status=<integer>]
 & [scenarioImpressions=<integer>]
 & [isEvents=<integer>]
 & [isUnplaced=<integer>]
 & [backgroundColor=<string>]
 & [width=<string>]
 & [height=<string>]
 & [imageURL=<string>]
 & [getURL=<string>]
 & [hitURL=<string>]
 & [target=<string>]
 & [alt=<string>]
 & [flashParameterName=<string>]
 & [targetParameterName=<string>]
 & [userN=<string>]
 & [eventN=<string>]
 & [hitURLN=<string>]
 & [maxImpressions=<integer>]
 & [maxImpressionsPerDay=<integer>]
 & [maxImpressionsPerHour=<integer>]
 & [maxClicks=<integer>]
 & [maxClicksPerDay=<integer>]
 & [maxClicksPerHour=<integer>]
 & [impressionCode=<string>]
 & [previewCode=<string>]
 & [trackingURL=<string>]
 & [dateStart=<YYYY-MM-DD HH:mm>]
 & [dateEnd=<YYYY-MM-DD HH:mm>]
Query-параметры
campaignID *

ID кампании или флайта, в котором будет добавлен баннер.

См. также:

nameНазвание объекта. Может содержать русские и латинские буквы, цифры и любые символы.
targetingProfileID

ID профиля таргетирования.

Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности.

См. также:

templateID

ID шаблона баннера. Шаблон представляет собой код баннера с переменными и определяет внешний вид и функциональные возможности баннера на сайте.

См. также:

bannerTypeID

ID типа баннера.

Параметр обязателен, если не задан шаблон баннера (templateID).

См. также:

contentType *

Системные шаблоны.

Параметр обязателен, если не задан шаблон баннера (templateID).

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

  • Для стандартных типов:

    graphics — Графический баннер;

    flash — Flash-баннер;

    HTML — HTML-баннер.

  • Для xml типов:

    XML — XML-баннер.

  • Для безразмерных типов:

    floatingJS — JavaScript код (Безразмерный);

    floatingHTML — HTML код (Безразмерный).

  • Для безразмерных типов с базовыми шаблонами:

    floatingFlash1 — Flash с заглушкой;

    floatingFlash2 — Flash без заглушки;

    floatingImage — Изображение.

priority

Приоритет.

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

  • 1≤N≤1000, где N — от 1 до 1000 включительно.

Значение по умолчанию: 100.

status

Статус объекта. Могут быть показаны только объекты, находящиеся в статусе «активный».

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

  • 0 — активный — объект готов к началу открутки;
  • 1 — приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе ADFOX показывают приостановленные объекты в списке;
  • 2 — завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе ADFOX скрывают завершенные объекты.

Значение по умолчанию: 0.

scenarioImpressions

Количество показов по сценарию. Только при подключенном к аккаунту модуле « Сценарные показы ».

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

  • 0≤N≤99, где N — от 1 до 99 включительно.

Значение по умолчанию: 1.

isEvents

Получить ссылки на события.

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

  • 0 — выключено;
  • 1 — включено.

Значение по умолчанию: 0.

isUnplaced

Отключить размещение баннера на площадках, созданных после добавления баннера.

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

  • 0 — выключено;
  • 1 — включено.

Функционал зависит от подключенного в аккаунте модуля "Отключение размещения баннеров".

Если модуль подключен: значение по умолчанию 1.

Если модуль не подключен: значение по умолчанию 0.

backgroundColor

Цвет фона в формате HEX, например: #FFFFFF.

width

Ширина баннера.

height

Высота баннера.

imageURL

Ссылка на изображение графических баннеров, заглушку flash-баннеров.

getURL

Ссылка на flash-ролик для flash-баннеров.

hitURL

Ссылка для перехода на сайт рекламодателя.

target

Значение параметра target для ссылки — определяет, в каком окне открыть ссылку.

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

  • _blank — открыть страницу в новом окне браузера;
  • _parent — открыть страницу в текущем окне;
  • _top — открыть страницу в полном окне браузера.
alt

Значение параметра alt для тега img — альтернативный текст для изображения.

flashParameterName

Имя параметра, используемого для передачи ссылки перехода во flash-ролик.

При разработке flash-ролика, в коде, который отвечает за обработку клика, используется параметр, ожидающий на вход ссылку для перехода.

Ссылка для перехода и имя параметра для передачи ссылки в ролик указываются при добавлении баннера в ADFOX.

Имя параметра в баннере и во flash-ролике должно совпадать.

targetParameterName

Имя параметра, используемого для передачи значения "target" во flash-ролик.

При разработке flash-ролика, в коде, который отвечает за обработку клика, используется параметр, ожидающий на вход значение target.

Ссылка для перехода и имя параметра для передачи значения target в ролик указываются при добавлении баннера в ADFOX.

Имя параметра в баннере и во flash-ролике должно совпадать.

userN

Пользовательские параметры, где N — номер используемого параметра от 1 до 25.

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

Например, в шаблоне используются 2 пользовательских параметра: user1 и user3 с типом данных «строка».

Значит, при добавлении или редактировании баннера необходимо в запросе передать:

user1=text1&user3=text3

eventN

Названия событий, где N — номер события от 1 до 30.

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

hitURLN

Укажите URL перехода для событий, где N в названии параметра — номер события от 1 до 30.

maxImpressions

Максимальное количество показов баннера.

Допустимые значения: целое число от 1 до 2147483647.

maxImpressionsPerDay

Максимальное количество показов в сутки.

Допустимые значения: целое число от 1 до 2147483647.

maxImpressionsPerHour

Максимальное количество показов в час.

Допустимые значения: целое число от 1 до 2147483647.

maxClicks

Максимальное количество кликов всего.

Допустимые значения: целое число от 1 до 2147483647.

maxClicksPerDay

Максимальное количество кликов в сутки.

Допустимые значения: целое число от 1 до 2147483647.

maxClicksPerHour

Максимальное количество кликов в час.

Допустимые значения: целое число от 1 до 2147483647.

impressionCode

В зависимости от типа баннера: HTML-код, либо XML-код, либо JavaScript.

previewCode

Только для XML-баннеров.

Укажите HTML-код, который покажет XML-баннер в окне предварительного просмотра баннера.

trackingURL

Ссылка на промерочный пиксель.

В ссылке на пиксель обычно присутствует переменная, ожидающая на вход случайное число. Это число помогает защитить ссылку от кеширования в браузере.

В ADFOX существует макрос для подстановки случайного числа к переменной — %random%.

Например, в ссылках на пиксель ADFOX, параметр для подстановки случайного числа pr, подставим к нему макрос:

http://ads.adfox.ru/166283/getCode?p1=borgd&p2=ezjv&pfb=dwsey&pr=%random%

dateStart

Дата начала открутки.

Значение по умолчанию: сегодня с 00:00.

Формат передачи даты и времени: YYYY-MM-DD HH:mm

dateEnd

Дата окончания открутки.

Формат передачи даты и времени: YYYY-MM-DD HH:mm

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

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

<response>
 <status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

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

code

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

ID

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

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=add&actionObject=banner&name=aptil2015&campaignID=444444

Ответ:

<response>
 <status>
  <code>0</code>
  <ID>456789</ID>
</status>
</response>

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

См. также другие действия с объектом banner: