activeBanners
Получить список баннеров, активных на указанную дату.
Формат запроса
Примечание
Доступна пагинация.
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=activeBanners
& date=<YYYY-MM-DD>
|
Дата, которая попадает в период активности баннера, то есть в это время баннер показывался и имеет статистику по показам и/или переходам. |
* Обязательный параметр
Формат ответа
<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>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве ответа. |
|
Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе). |
|
Идентификатор баннера. |
|
Название баннера. |
|
ID кампании. |
|
Название кампании. |
|
Дата старта кампании. |
|
Дата окончания кампании. |
|
ID типа баннера. |
|
Название типа баннера. |
|
Статус. Возможные значения:
|
|
Размещение баннера. Возможные значения:
|
|
Приоритет. |
|
Общее количество показов баннеров. |
|
Показов сегодня. |
|
Показов в текущий час. |
|
Общее количество кликов по баннерам. |
|
Кликов сегодня. |
|
Кликов в текущий час. |
|
Дата начала открутки. |
|
Дата окончания открутки. |
|
Дата добавления. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?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>2020-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>2021-11-27 00:00:00</dateStart> <dateEnd/> <dateAdded>2021-11-27 13:09:57</dateAdded> </row0> </response>
Дата, которая попадает в период активности баннера, то есть в это время баннер показывался и имеет статистику по показам и/или переходам.
Обязательный параметр