superCampaign
Получить список суперкампаний.
Формат запроса
Примечание
Доступна пагинация.
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=superCampaign
& [actionObjectID=<integer>]
& [dateAddedFrom=<YYYY-MM-DD>]
& [dateAddedTo=<YYYY-MM-DD>]
& [show=<string>]
& [search=<string>]
|
Чтобы получить данные только по одной суперкампании, укажите ее идентификатор. Значение по умолчанию: 0 — выводить список всех суперкампаний. |
|
Фильтрация данных: вывести суперкампании, созданные после указанной даты. |
|
Фильтрация данных: вывести суперкампании, созданные до указанной даты. |
|
Настройка вывода данных. Допустимые значения:
Значение по умолчанию: |
|
Фильтрация по подстроке в имени суперкампании. Может содержать русские и латинские буквы, цифры и любые символы. |
* Обязательный параметр
Формат ответа
<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>
<dateStart>{date}</dateStart>
<dateEnd>{date}</dateEnd>
<dateFinished>{date}</dateFinished>
<dateAdded>{date}</dateAdded>
</row0>
</data>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Элемент списка с соответствующим номером. |
|
Название суперкампании. |
|
ID рекламодателя. |
|
Учетная запись рекламодателя. |
|
ID ассистента, которому приписана суперкампания. |
|
Учетная запись ассистента, которому приписана суперкампания. |
|
ID дополнительных рекламодателей. |
|
Учетные записи дополнительных рекламодателей. |
|
ID дополнительных ассистентов. |
|
Учетные записи дополнительных ассистентов. |
|
Тип кампании. Возможные значения:
|
|
Уровень суперкампании от 1 до 10. |
|
Приоритет суперкампании. |
|
Статус. |
|
Методика подсчета показов. Возможные значения:
|
|
Ограничение показов всего. |
|
Ограничение показов в сутки. |
|
Ограничение показов в час. |
|
Ограничение кликов всего. |
|
Ограничение кликов в сутки. |
|
Ограничение кликов в час. |
|
Максимальное количество активных событий. |
|
Максимальное количество активных событий в сутки. |
|
Максимальное количество активных событий в час. |
|
Максимальное количество показов посетителю. |
|
Максимальное количество переходов для посетителя. |
|
Дата начала периода кампании. |
|
Период частоты показов. |
|
Если период частоты показов выбран как «другой период» ( |
|
Количество показов за период. |
|
Минимальный период между показами. |
|
Период частоты переходов. |
|
Если период частоты переходов выбран как «другой период» ( |
|
Количество переходов за период. |
|
Минимальный период между переходами. |
|
Дата начала суперкампании. |
|
Дата окончания суперкампании. |
|
Дата завершения открутки. |
|
Дата добавления суперкампании. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?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> <dateStart>2021-07-02 00:00:00</dateStart> <dateEnd>2022-03-31 23:59:00</dateEnd> <dateFinished>2022-04-01 00:30:01</dateFinished> <dateAdded>2021-07-02</dateAdded> </row0> </data> </response>
Другие действия с объектом
Читайте также о других действиях с объектом superCampaign
:
- добавить суперкампанию;
- удалить суперкампанию;
- редактировать суперкампанию;
- добавить дополнительного ассистента;
- добавить дополнительного рекламодателя;
- удалить дополнительного ассистента;
- удалить дополнительного рекламодателя.
Чтобы получить данные только по одной суперкампании, укажите ее идентификатор.
Значение по умолчанию: 0 — выводить список всех суперкампаний.
Фильтрация данных: вывести суперкампании, созданные после указанной даты.
Фильтрация данных: вывести суперкампании, созданные до указанной даты.
Настройка вывода данных.
Допустимые значения:
-
common
— краткий вывод:- ID;
- name.
-
short
— сокращенный вывод:- ID;
- name;
- status;
- dateStart;
- dateEnd;
- dateFinished.
-
advanced
— полный вывод.
Значение по умолчанию: advanced
.
Фильтрация по подстроке в имени суперкампании.
Может содержать русские и латинские буквы, цифры и любые символы.
Обязательный параметр