bannerPlaceReport

Получить статистику по кампаниям/баннерам/площадкам за день. Метод доступен только для пользователя с ролью «администратор».

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

Примечание

Доступна пагинация.

https://adfox.yandex.ru/api/v1
  ? object=account
  & action=list
  & actionObject=bannerPlaceReport
  & date=<YYYY-MM-DD>

date*

Дата, за которую нужно получить данные.

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

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

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

<response>
  <status>
    <code>{integer}</code>
  </status>
  <data>
   <result>
    <row0>
     <campaignID>{integer}</campaignID>
     <campaignName>{string}</campaignName>
     <bannerID>{integer}</bannerID>
     <bannerName>{string}</bannerName>
     <siteID>{integer}</siteID>
     <siteName>{string}</siteName>
     <sectionID>{integer}</sectionID>
     <sectionName>{string}</sectionName>
     <placeID>{integer}</placeID>
     <placeName>{string}</placeName>
     <impressions>{integer}</impressions>
     <clicks>{integer}</clicks>
     <bannerTypeID>{integer}</bannerTypeID>
     <bannerTypeIDName>{string}</bannerTypeIDName>
    </row0>
</response>

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

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

rowN

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

campaignID

ID кампании.

campaignName

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

bannerID

ID баннера.

bannerName

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

siteID

ID сайта в управлении.

siteName

Название сайта в управлении.

sectionID

ID раздела сайта.

sectionName

Название раздела сайта.

placeID

ID площадки.

placeName

Название площадки.

impressions

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

clicks

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

bannerTypeID

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

bannerTypeName

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

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

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=bannerPlaceReport&date=2022-01-27

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <campaignID>457410</campaignID>
     <campaignName>example</campaignName>
     <bannerID>1240863</bannerID>
     <bannerName>banner_test</bannerName>
     <siteID>35001</siteID>
     <siteName>site_test</siteName>
     <sectionID>73929</sectionID>
     <sectionName>section_test</sectionName>
     <placeID>772394</placeID>
     <placeName>place_test</placeName>
     <impressions>503</impressions>
     <clicks>0</clicks>
     <bannerTypeID>87751</bannerTypeID>
     <bannerTypeIDName>type_1</bannerTypeIDName>
    </row0>
</response>
Предыдущая
Следующая