superCampaign

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

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

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

Примечание. Доступна пагинация.
https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=list
 & actionObject=superCampaign
 & [actionObjectID=<integer>]
 & [dateAddedFrom=<YYYY-MM-DD>]
 & [dateAddedTo=<YYYY-MM-DD>]
 & [show=<string>]
 & [search=<string>]
Query-параметры
actionObjectID

Чтобы получить данные только по одной суперкампании, укажите её идентификатор.

Значение по умолчанию: 0 — выводить список всех суперкампаний.

dateAddedFrom

Фильтрация данных: вывести суперкампании, созданные после указанной даты.

dateAddedTo

Фильтрация данных: вывести суперкампании, созданные до указанной даты.

show

Настройка вывода данных.

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

  • common— краткий вывод:
    • ID;
    • name.
  • short — сокращенный вывод:
    • ID;
    • name;
    • status;
    • dateStart;
    • dateEnd;
    • dateFinished.
  • advanced — полный вывод.

Значение по умолчанию: advanced.

search

Фильтрация по подстроке в имени суперкампании.

Может содержать русские и латинские буквы, цифры и любые символы.

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

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

<response>
  <status>
   <code>{integer}</code>
  </status>
  <result>
   <data>
    <row0>
     <ID>{integer}</ID>
     <name>{string}</name>
     <advertiserID>{integer}</advertiserID>
     <advertiserAccount>{string}</advertiserAccount>
     <assistantID>{integer}</assistantID>
     <assistantAccount>{string}</assistantAccount>
     <additionalAdvertiserIDs/>
     <additionalAdvertiserAccounts/>
     <additionalAssistantIDs/>
     <additionalAssistantAccounts/>
     <logicType>{integer}</logicType>
     <type>{integer}</type>
     <level>{integer}</level>
     <priority>{integer}</priority>
     <status>{integer}</status>
     <impressionsMethodID>{integer}</impressionsMethodID>
     <maxImpressions>{integer}</maxImpressions>
     <maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
     <maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
     <maxClicks>{integer}</maxClicks>
     <maxClicksPerDay>{integer}</maxClicksPerDay>
     <maxClicksPerHour>{integer}</maxClicksPerHour>
     <maxActiveEvents>{integer}</maxActiveEvents>
     <maxActiveEventsPerDay>{integer}</maxActiveEventsPerDay>
     <maxActiveEventsPerHour>{integer}</maxActiveEventsPerHour>
     <maxUniqueImpressions>{integer}</maxUniqueImpressions>
     <maxUniqueClicks>{integer}</maxUniqueClicks>
     <datePeriod/>
     <frequencyTypeImpressions>{integer}</frequencyTypeImpressions>
     <uniquePeriodImpressions>{string}</uniquePeriodImpressions>
     <impressionsPerPeriod>{integer}</impressionsPerPeriod>
     <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
     <frequencyTypeClicks>{integer}</frequencyTypeClicks>
     <uniquePeriodClicks>0:00</uniquePeriodClicks>
     <clicksPerPeriod>{integer}</clicksPerPeriod>
     <minimalPeriodClicks>0:00</minimalPeriodClicks>
     <pricingModel>{integer}</pricingModel>
     <itemCost>{string}</itemCost>
     <itemQty>{integer}</itemQty>
     <dateStart>{date}</dateStart>
     <dateEnd>{date}</dateEnd>
     <dateFinished>{date}</dateFinished>
     <dateAdded>{date}</dateAdded>
    </row0>
   </data>
</response>

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

code

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

rowN

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

name

Название суперкампании.

advertiserID
ID рекламодателя.
advertiserAccount

Учетная запись рекламодателя.

assistantID

ID ассистента, которому приписана суперкампания.

assistantAccount

Учетная запись ассистента, которому приписана суперкампания.

additionalAdvertiserIDs

ID дополнительных рекламодателей.

additionalAdvertiserAccounts

Учетные записи дополнительных рекламодателей.

additionalAssistantIDs

ID дополнительных ассистентов.

additionalAssistantAccounts

Учетные записи дополнительных ассистентов.

logicType

Тип кампании.

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

  • 0 — коммерческая;
  • 1 — промерочная.
level

Уровень суперкампании от 1 до 10.

priority

Приоритет.

status

Статус.

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

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

Методика подсчета показов.

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

  • -1 — не переопределено. Значение наследуется из настроек аккаунта и применяется ко всем кампаниям;
  • 0 — загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта;
  • 101≤N≤130, где N — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером.
maxImpressions

Максимальное количество показов.

maxImpressionsPerDay

Максимальное количество показов в сутки.

maxImpressionsPerHour

Максимальное количество показов в час.

maxClicks

Максимальное кликов всего.

maxClicksPerDay

Максимальное количество кликов в сутки.

maxClicksPerHour

Максимальное количество кликов в час.

maxActiveEvents

Максимальное количество активных событий.

maxActiveEventsPerDay

Максимальное количество активных событий в сутки.

maxActiveEventsPerHour

Максимальное количество активных событий в час.

maxUniqueImpressions

Максимальное количество показов посетителю.

maxUniqueClicks

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

datePeriod

Дата начала периода кампании.

frequencyTypeImpressions

Период частоты показов.

uniquePeriodImpressions

Если период частоты показов выбран как «другой период» (frequencyTypeImpressions=8), то указывается свой собственный период для показов баннеров уникальному пользователю в часах и минутах.

impressionsPerPeriod

Количество показов за период.

minimalPeriodImpressions

Минимальный период между показами.

frequencyTypeClicks

Период частоты переходов.

uniquePeriodClicks
Если период частоты переходов выбран как «другой период» (frequencyTypeClicks=8), то указывается свой собственный период для показов баннеров уникальному пользователю в часах и минутах.
clicksPerPeriod

Количество переходов за период.

minimalPeriodClicks

Минимальный период между переходами.

pricingModel

Модель ценообразования. Для продукта ADFOX.Nets.

itemCost

Стоимость единицы. Для продукта ADFOX.Nets.

itemQty

Количество единиц. Для продукта ADFOX.Nets.

dateStart

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

dateEnd

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

dateFinished

Дата завершения открутки.

dateAdded

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

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=list&actionObject=superCampaign

Ответ:

<response>
  <status>
   <code>0</code>
  </status>
  <result>
   <data>
    <row0>
     <ID>29038</ID>
     <name>example</name>
     <advertiserID>226201</advertiserID>
     <advertiserAccount>petrov</advertiserAccount>
     <assistantID>221327</assistantID>
     <assistantAccount>ivanov</assistantAccount>
     <additionalAdvertiserIDs/>
     <additionalAdvertiserAccounts/>
     <additionalAssistantIDs/>
     <additionalAssistantAccounts/>
     <logicType>0</logicType>
     <type>0</type>
     <level>1</level>
     <priority>100</priority>
     <status>2</status>
     <impressionsMethodID>0</impressionsMethodID>
     <maxImpressions>0</maxImpressions>
     <maxImpressionsPerDay>0</maxImpressionsPerDay>
     <maxImpressionsPerHour>0</maxImpressionsPerHour>
     <maxClicks>0</maxClicks>
     <maxClicksPerDay>0</maxClicksPerDay>
     <maxClicksPerHour>0</maxClicksPerHour>
     <maxActiveEvents>0</maxActiveEvents>
     <maxActiveEventsPerDay>0</maxActiveEventsPerDay>
     <maxActiveEventsPerHour>0</maxActiveEventsPerHour>
     <maxUniqueImpressions>0</maxUniqueImpressions>
     <maxUniqueClicks>0</maxUniqueClicks>
     <datePeriod/>
     <frequencyTypeImpressions>6</frequencyTypeImpressions>
     <uniquePeriodImpressions>0:00</uniquePeriodImpressions>
     <impressionsPerPeriod>1</impressionsPerPeriod>
     <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
     <frequencyTypeClicks>0</frequencyTypeClicks>
     <uniquePeriodClicks>0:00</uniquePeriodClicks>
     <clicksPerPeriod>1</clicksPerPeriod>
     <minimalPeriodClicks>0:00</minimalPeriodClicks>
     <pricingModel>0</pricingModel>
     <itemCost>0.00</itemCost>
     <itemQty>0</itemQty>
     <dateStart>2014-07-02 00:00:00</dateStart>
     <dateEnd>2015-03-31 23:59:00</dateEnd>
     <dateFinished>2015-04-01 00:30:01</dateFinished>
     <dateAdded>2014-07-02</dateAdded>
    </row0>
   </data>
</response>

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

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