activeBanners

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

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

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

Примечание. Доступна пагинация.
https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=list
 & actionObject=activeBanners
 & date=<YYYY-MM-DD>
Query-параметры
date *

Дата, которая попадает в период активности баннера, то есть в это время баннер показывался и имеет статистику по показам и/или переходам.

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <campaignID>{integer}</campaignID>
     <campaignName>{string}</campaignName>
     <campaignDateStart>{date}</campaignDateStart>
     <campaignDateEnd>{date}</campaignDateEnd>
     <bannerTypeID>{integer}</bannerTypeID>
     <bannerTypeName>{string}</bannerTypeName>
     <status>{integer}</status>
     <isUnplaced>{integer}</isUnplaced>
     <priority>{integer}</priority>
     <impressions>{integer}</impressions>
     <impressionsToday>{integer}</impressionsToday>
     <impressionsHour>{integer}</impressionsHour>
     <clicks>{integer}</clicks>
     <clicksToday>{integer}</clicksToday>
     <clicksHour>{integer}</clicksHour>
     <dateStart>{date}</dateStart>
     <dateEnd>{date}</dateEnd>
     <dateAdded>{date}</dateAdded>
    </row0>
</response>

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

code

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

rows

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

rowN

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

ID

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

name

Название баннера.

campaignID

ID кампании.

campaignName

Название кампании.

campaignDateStart

Дата старта кампании.

campaignDateEnd

Дата окончания кампании.

bannerTypeID

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

bannerTypeName

Название типа баннера.

status

Статус.

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

  • 0 — активный;
  • 1 — приостановленный;
  • 2 — завершенный.
isUnplaced

Размещение баннера.

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

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

Приоритет.

impressions

Общее количество показов баннеров.

impressionsToday

Показов сегодня.

impressionsHour

Показов в текущий час.

clicks

Общее количество кликов по баннерам.

clicksToday

Кликов сегодня.

clicksHour

Кликов в текущий час.

dateStart

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

dateEnd

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

dateAdded

Дата добавления.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=activeBanners&date=YYYY-MM-DD

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <ID>900088</ID>
     <name>#900088</name>
     <campaignID>321510</campaignID>
     <campaignName>1</campaignName>
     <campaignDateStart>2013-11-27 00:00:00</campaignDateStart>
     <campaignDateEnd/>
     <bannerTypeID>17</bannerTypeID>
     <bannerTypeName>600x90</bannerTypeName>
     <status>0</status>
     <isUnplaced>0</isUnplaced>
     <priority>100</priority>
     <impressions>4</impressions>
     <impressionsToday>0</impressionsToday>
     <impressionsHour>0</impressionsHour>
     <clicks>0</clicks>
     <clicksToday>0</clicksToday>
     <clicksHour>0</clicksHour>
     <dateStart>2013-11-27 00:00:00</dateStart>
     <dateEnd/>
     <dateAdded>2013-11-27 13:09:57</dateAdded>
    </row0>
</response>