placement2

Получить информацию о размещении кампании.

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

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

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

ID кампании.

dataType *

Тип данных.

Допустимые значения:

  • campaignSites – сайт;

  • campaignSections – раздел;

  • campaignPlaces – площадка;

  • campaignAdnetworks – рекламная сеть;

  • campaignAdnetworkCategories – категория рекламной сети;

  • campaignAdnetworkWebsites — сайт рекламной сети;

  • placesComputed — листинг сайтов, разделов и площадок.

websiteID *

ID сайта.

Параметр обязателен для типа данных campaignSections.

sectionID *

ID раздела.

Параметр обязателен для типа данных campaignPlaces.

adNetworkID *

ID рекламной сети.

Параметр обязателен для типа данных campaignAdnetworkCategories и campaignAdnetworkWebsites.

categoryID *

ID категории рекламной сети.

Параметр обязателен для типа данных campaignAdnetworkWebsites.

isOn *

Выводить данные о включенных/выключенных размещениях.

Допустимые значения:

  • on — выводить данные только о включенном размещении;
  • off — выводить данные о включенном и выключенном размещении.

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

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

 <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>

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

code

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

rows

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

rowN

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

websiteID

ID сайта.

websiteName

Название сайта.

isSiteOn

Признак включения размещения.

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

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

Модель ценообразования.

itemCost

Стоимость единицы.

itemQty

Количество единиц.

maxImpressions

Максимальное количество показов для данного размещения.

maxImpressionsPerDay

Максимальное количество показов в сутки для данного размещения.

maxImpressionsPerHour

Максимальное количество показов в час для данного размещения.

impressions

Показания счетчиков для данного размещения — показы за все время.

impressionsPerDay

Показания счетчиков для данного размещения — показы за сутки.

impressionsPerHour

Показания счетчиков для данного размещения — показы за час.

maxClicks

Максимальное количество кликов для данного размещения.

maxClicksPerDay

Максимальное количество кликов в сутки для данного размещения.

maxClicksPerHour

Максимальное количество кликов в час для данного размещения.

clicks

Показания счетчиков для данного размещения — клики за все время.

clicksPerDay

Показания счетчиков для данного размещения — клики за сегодня.

clicksPerHour

Показания счетчиков для данного размещения — клики за час.

maxActiveEvents

Максимальное количество вызовов события для данного размещения.

maxActive

Максимальное количество вызовов события в сутки для данного размещения.

maxActiveEventsPerHour

Максимальное количество вызовов события в час для данного размещения.

activeEvents

Показания счетчиков для данного размещения — события за все время.

activeEventsPerDay

Показания счетчиков для данного размещения — события за сутки.

activeEventsPerHour

Показания счетчиков для данного размещения — события за час.

dateStart

Дата старта для данного размещения.

dateEnd

Дата завершения открутки кампании для данного размещения.

rotationMethodID

ID метода ротации для данного размещения.

targetingProfileID

ID профиля таргетирования.

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

  • —1 — не переопределен (значение наследуется от уровня выше);
  • 0 — по приоритетности;
  • 1 — по % от трафика.
profileWebsiteID

ID профиля размещения.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&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: