placement2
Получить информацию о размещении кампании.
Формат запроса
Примечание
Доступна пагинация.
https://adfox.yandex.ru/api/v1
? object=campaign
& action=info
& actionObject=placement2
& objectID=<integer>
& dataType=<string>
& websiteID=<integer>
& sectionID=<integer>
& isOn=<string>
|
ID кампании. |
|
Тип данных. Допустимые значения:
|
|
ID сайта. Параметр обязателен для типа данных |
|
ID раздела. Параметр обязателен для типа данных |
|
Выводить данные о включенных/выключенных размещениях. Допустимые значения:
|
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
<data>
<row0>
<websiteID>{integer}</websiteID>
<websiteName>{string}</websiteName>
<isSiteOn>{integer}</isSiteOn>
<pricingModel>{integer}</pricingModel>
<itemCost>{integer}</itemCost>
<itemQty>{integer}</itemQty>
<maxImpressions>{integer}</maxImpressions>
<maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
<maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
<impressions>{integer}</impressions>
<impressionsPerDay>{integer}</impressionsPerDay>
<impressionsPerHour>{integer}</impressionsPerHour>
<maxClicks>{integer}</maxClicks>
<maxClicksPerDay>{integer}</maxClicksPerDay>
<maxClicksPerHour>{integer}</maxClicksPerHour>
<clicks>{integer}</clicks>
<clicksPerDay>{integer}</clicksPerDay>
<clicksPerHour>{integer}</clicksPerHour>
<maxActiveEvents>{integer}</maxActiveEvents>
<maxActiveEventsPerDay>{integer}</maxActiveEventsPerDay>
<maxActiveEventsPerHour>{integer}</maxActiveEventsPerHour>
<activeEvents>{integer}</activeEvents>
<activeEventsPerDay>{integer}</activeEventsPerDay>
<activeEventsPerHour>{integer}</activeEventsPerHour>
<isSiteLimitsOff>{integer}</isSiteLimitsOff>
<dateStart>{date}</dateStart>
<dateEnd>{date}</dateEnd>
<rotationMethodID>{integer}</rotationMethodID>
<targetingProfileID>{integer}</targetingProfileID>
<profileWebsiteID>{integer}</profileWebsiteID>
<isFullRedefinition>{integer}</isFullRedefinition>
<isFullRedefinitionSimplified>{integer}</isFullRedefinitionSimplified>
<daysElapsed>{integer}</daysElapsed>
</row0>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве ответа. |
|
Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе). |
|
ID сайта. |
|
Название сайта. |
|
Признак включения размещения. Возможные значения:
|
|
Модель ценообразования. |
|
Стоимость единицы. |
|
Количество единиц. |
|
Максимальное количество показов для данного размещения. |
|
Максимальное количество показов в сутки для данного размещения. |
|
Максимальное количество показов в час для данного размещения. |
|
Показания счетчиков для данного размещения — показы за все время. |
|
Показания счетчиков для данного размещения — показы за сутки. |
|
Показания счетчиков для данного размещения — показы за час. |
|
Максимальное количество кликов для данного размещения. |
|
Максимальное количество кликов в сутки для данного размещения. |
|
Максимальное количество кликов в час для данного размещения. |
|
Показания счетчиков для данного размещения — клики за все время. |
|
Показания счетчиков для данного размещения — клики за сегодня. |
|
Показания счетчиков для данного размещения — клики за час. |
|
Максимальное количество вызовов события для данного размещения. |
|
Максимальное количество вызовов события в сутки для данного размещения. |
|
Максимальное количество вызовов события в час для данного размещения. |
|
Показания счетчиков для данного размещения — события за все время. |
|
Показания счетчиков для данного размещения — события за сутки. |
|
Показания счетчиков для данного размещения — события за час. |
|
Дата старта для данного размещения. |
|
Дата завершения открутки кампании для данного размещения. |
|
ID метода ротации для данного размещения. |
|
ID профиля таргетирования. Возможные значения:
|
|
ID профиля размещения. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=campaign&action=info&actionObject=placement2&objectID=474205&dataType=campaignSites
Ответ:
<response> <status> <code>0</code> <ID>474205</ID> </status> <data> <row0> <websiteID>35862</websiteID> <websiteName>1</websiteName> <isSiteOn>1</isSiteOn> <pricingModel>0</pricingModel> <itemCost>0.00</itemCost> <itemQty>0</itemQty> <maxImpressions>0</maxImpressions> <maxImpressionsPerDay>0</maxImpressionsPerDay> <maxImpressionsPerHour>0</maxImpressionsPerHour> <impressions>11</impressions> <impressionsPerDay>0</impressionsPerDay> <impressionsPerHour>0</impressionsPerHour> <maxClicks>0</maxClicks> <maxClicksPerDay>0</maxClicksPerDay> <maxClicksPerHour>0</maxClicksPerHour> <clicks>0</clicks> <clicksPerDay>0</clicksPerDay> <clicksPerHour>0</clicksPerHour> <maxActiveEvents>0</maxActiveEvents> <maxActiveEventsPerDay>0</maxActiveEventsPerDay> <maxActiveEventsPerHour>0</maxActiveEventsPerHour> <activeEvents>0</activeEvents> <activeEventsPerDay>0</activeEventsPerDay> <activeEventsPerHour>0</activeEventsPerHour> <isSiteLimitsOff>0</isSiteLimitsOff> <dateStart/> <dateEnd/> <rotationMethodID>-1</rotationMethodID> <targetingProfileID>-1</targetingProfileID> <profileWebsiteID>0</profileWebsiteID> <isFullRedefinition/> <isFullRedefinitionSimplified>0</isFullRedefinitionSimplified> <daysElapsed>0</daysElapsed> </row0> </response>
Другие действия с объектом
Читайте также о других действиях с объектом campaign
:
- добавить кампанию
- получить список кампаний;
- удалить кампанию;
- редактировать кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке;
- получить информацию о размещении баннеров кампании.
ID кампании.
Тип данных.
Допустимые значения:
-
campaignSites
– сайт; -
campaignSections
– раздел; -
campaignPlaces
– площадка; -
placesComputed
— листинг сайтов, разделов и площадок.
ID сайта.
Параметр обязателен для типа данных campaignSections
.
ID раздела.
Параметр обязателен для типа данных campaignPlaces
.
Выводить данные о включенных/выключенных размещениях.
Допустимые значения:
-
on
— выводить данные только о включенном размещении; -
off
— выводить данные о включенном и выключенном размещении.
Обязательный параметр