banner

Получить список баннеров одной рекламной кампании.

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

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

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

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

См. также:

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

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

 <response>
  <status>
    <code>{integer}</code>
  </status>
  <result>
   <rows>{integer}</rows>
   <data>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <status>{integer}</status>
     <statusName>{string}</statusName>
     <priority>{integer}</priority>
     <bannerTypeID>{integer}</bannerTypeID>
     <bannerTypeName>{string}</bannerTypeName>
     <impressions>{integer}</impressions>
     <impressionsToday>{integer}</impressionsToday>
     <clicks>{integer}</clicks>
     <clicksToday>{integer}</clicksToday>
     <dateStart>{date}</dateStart>
     <dateEnd>{date}</dateEnd>
     <dateAdded>{date}</dateAdded>
    </row0>
    <row1>...</row1>
   </data>
  </result>
</response>

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

code

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

rows

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

rowN

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

ID
Идентификатор баннера.
name
Название баннера.
status

Статус.

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

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

Приоритет.

bannerTypeID

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

bannerTypeName

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

impressions

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

impressionsToday

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

clicks

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

clicksToday

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

dateStart

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

dateEnd

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

dateAdded

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

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=list&actionObject=banner&objectID=474205

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <result>
   <rows>2</rows>
   <data>
    <row0>
     <ID>1262260</ID>
     <name>test</name>
     <status>0</status>
     <statusName>active</statusName>
     <priority>100</priority>
     <bannerTypeID>77524</bannerTypeID>
     <bannerTypeName>240x400 js</bannerTypeName>
     <impressions>1</impressions>
     <impressionsToday>0</impressionsToday>
     <clicks>0</clicks>
     <clicksToday>0</clicksToday>
     <dateStart>2015-04-06 00:00:00</dateStart>
     <dateEnd/>
     <dateAdded>2015-04-06 15:25:20</dateAdded>
    </row0>
    <row1>...</row1>
   </data>
  </result>
</response>

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

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