campaign
Получить список кампаний.
Формат запроса
Примечание
Доступна пагинация.
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=campaign
& [actionObjectID=<integer>]
& [superCampaignID=<integer>]
& [dateAddedFrom=<YYYY-MM-DD>]
& [dateAddedTo=<YYYY-MM-DD>]
& [show=<string>]
& [search=<string>]
& [criteriaID=<integer>]
& [showMode=<string>]
|
Чтобы получить данные только по одной кампании, укажите его идентификатор. Значение по умолчанию: 0 — выводить список всех кампаний. |
|
Фильтр по ID суперкампании. |
|
Фильтрация данных: вывести кампании, созданные после указанной даты. Формат передачи даты: |
|
Фильтрация данных: вывести кампании, созданные до указанной даты. Формат передачи даты: |
|
Параметр применяется для указания полноты данных в списке кампаний, а также для вывода настроек таргетирования конкретной кампании. Настройка полноты данных в списке кампаний: Допустимые значения:
Значение по умолчанию: Настройка вывода таргетирования конкретной кампании:
Допустимые значения:
|
|
Фильтрация по подстроке в имени суперкампании. Может содержать русские и латинские буквы, цифры и любые символы. |
|
Обязателен только для получения данных по пользовательскому таргетированию ( show=targetingUser). Идентификатор пользовательской характеристики. Допустимые значения: от 1 до 63. |
|
Используется только для получения данных по пользовательскому таргетированию (show=targetingUser). Позволяет выводить список разрешенных и/или запрещенных значений указанной пользовательской характеристики в рекламной кампании. Допустимые значения:
Значение по умолчанию: denied. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
<data>
<result>
<row0>
<ID>{integer}</ID>
<name>{string}</name>
<superCampaignID>{integer}</superCampaignID>
<superCampaignName>{string}</superCampaignName>
<advertiserID>{integer}</advertiserID>
<advertiserAccount>{string}</advertiserAccount>
<assistantID>{integer}</assistantID>
<assistantAccount>{string}</assistantAccount>
<additionalAdvertiserIDs>{integer}</additionalAdvertiserIDs>
<additionalAdvertiserAccounts>{string}</additionalAdvertiserAccounts>
<additionalAssistantIDs>{integer}</additionalAssistantIDs>
<additionalAssistantAccounts>{string}</additionalAssistantAccounts>
<status>{integer}</status>
<level>{integer}</level>
<sequence>{integer}</sequence>
<priority>{integer}</priority>
<type>{integer}</type>
<tracingPointsType>{integer}</tracingPointsType>
<targetingProfileID>{integer}</targetingProfileID>
<isSession>{integer}</isSession>
<outerMarkID>{integer}</outerMarkID>
<bannerSequence>{integer}</bannerSequence>
<scenarioPeriodID>{integer}</scenarioPeriodID>
<impressionsMethodID>{integer}</impressionsMethodID>
<impressionsSmoothTypeID>{integer}</impressionsSmoothTypeID>
<clicksSmoothTypeID>{integer}</clicksSmoothTypeID>
<isTrafficSmooth>{integer}</isTrafficSmooth>
<maxImpressions>{integer}</maxImpressions>
<maxClicks>{integer}</maxClicks>
<impressionsAll>{integer}</impressionsAll>
<clicksAll>{integer}</clicksAll>
<impressionsToday>{integer}</impressionsToday>
<clicksToday>{integer}</clicksToday>
<maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
<maxClicksPerDay>{integer}</maxClicksPerDay>
<maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
<maxClicksPerHour>{integer}</maxClicksPerHour>
<impressionsPerHour>{integer}</impressionsPerHour>
<clicksPerHour>{integer}</clicksPerHour>
<mainPointID>{integer}</mainPointID>
<dateStart>{date}</dateStart>
<dateEnd>{date}</dateEnd>
<dateFinished>{date}</dateFinished>
<dateAdded>{date}</dateAdded>
<common_profile_id>{integer}</common_profile_id>
<costType>{integer}</costType>
<sendToErir>{integer}</sendToErir>
<contractID>{integer}</contractID>
<okveds>
<row0>{string}</row0>
<row1>{string}</row1>
</okveds>
<markingAdvertiserInfo>{string}</markingAdvertiserInfo>
</row0>
</result>
</data>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве ответа. |
|
Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе). |
|
Уникальный идентификатор кампании. |
|
Название кампании. |
|
ID суперкампании, которой принадлежит кампания. |
|
Название суперкампании, которой принадлежит кампания. |
|
ID рекламодателя. |
|
Учетная запись рекламодателя. |
|
ID ассистента, которому приписана кампания. |
|
Учетная запись ассистента, которому приписана кампания. |
|
ID дополнительных рекламодателей. |
|
Учетные записи дополнительных рекламодателей. |
|
ID дополнительных ассистентов. |
|
Учетные записи дополнительных ассистентов. |
|
Уровень кампании. |
|
Приоритет кампании. |
|
Статус. Возможные значения:
|
|
Группа. |
|
Тип кампании. Устаревший параметр. Возможные значения:
|
|
Учет действий. Возможные значения:
|
|
ID профиля таргетирования. |
|
Возможные значения:
|
|
Включена автоматическая подстановка меток к ссылкам для перехода. Возможные значения:
|
|
Последовательность показов баннеров. Устаревший параметр. Возможные значения:
|
|
Период сценария — определяет периодичность повтора показов баннеров этой рекламной кампании для уникального пользователя. Устаревший параметр. Обязателен, если последовательность показа — по сценарию ( Возможные значения:
|
|
Методика подсчета показов. Возможные значения:
|
|
Скорость открутки показов. Возможные значения:
|
|
Скорость открутки переходов. Допустимые значения:
|
|
Максимальное количество показов. |
|
Показания счетчиков. Показов всего. |
|
Максимальное количество показов в сутки. |
|
Показания счетчиков. Показов в текущие сутки. |
|
Максимальное количество показов в час. |
|
Показания счетчиков. Показов в текущий час. |
|
Максимальное кликов всего. |
|
Показания счетчиков. Кликов всего. |
|
Максимальное количество кликов в сутки. |
|
Показания счетчиков. Кликов в текущие сутки. |
|
Максимальное количество кликов в час. |
|
Показания счетчиков. Кликов в текущий час. |
|
Дата начала открутки. |
|
Дата окончания открутки. |
|
Дата завершения открутки. |
|
Дата добавления. |
|
Идентификатор общего профиля для |
|
Тип кампании. Допустимые значения:
|
|
Передавать данные в ЕРИР. Допустимые значения:
|
|
Идентификатор договора. Обязательно для заполнения, если значение |
|
ОКВЭД рекламируемого товара. |
|
Информация о рекламодателе в рекламном меню баннера. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=campaign
Ответ:
<response> <status> <code>0</code> </status> <data> <result> <row0> <ID>474205</ID> <name>example</name> <superCampaignID/> <superCampaignName/> <advertiserID>226201</advertiserID> <advertiserAccount>ivanov</advertiserAccount> <assistantID>239097</assistantID> <assistantAccount>petrov</assistantAccount> <additionalAdvertiserIDs/> <additionalAdvertiserAccounts/> <additionalAssistantIDs/> <additionalAssistantAccounts/> <status>0</status> <level>1</level> <sequence>1</sequence> <priority>100</priority> <type>1</type> <tracingPointsType>0</tracingPointsType> <targetingProfileID>0</targetingProfileID> <isSession>0</isSession> <outerMarkID>0</outerMarkID> <bannerSequence>0</bannerSequence> <scenarioPeriodID>0</scenarioPeriodID> <impressionsMethodID>0</impressionsMethodID> <impressionsSmoothTypeID>0</impressionsSmoothTypeID> <clicksSmoothTypeID>0</clicksSmoothTypeID> <isTrafficSmooth>0</isTrafficSmooth> <maxImpressions>0</maxImpressions> <maxClicks>0</maxClicks> <impressionsAll>0</impressionsAll> <clicksAll>0</clicksAll> <impressionsToday>0</impressionsToday> <clicksToday>0</clicksToday> <maxImpressionsPerDay>0</maxImpressionsPerDay> <maxClicksPerDay>0</maxClicksPerDay> <maxImpressionsPerHour>0</maxImpressionsPerHour> <maxClicksPerHour>0</maxClicksPerHour> <impressionsPerHour>0</impressionsPerHour> <clicksPerHour>0</clicksPerHour> <mainPointID>0</mainPointID> <dateStart>2021-05-18 13:00:00</dateStart> <dateEnd/> <dateFinished>0000-00-00 00:00:00</dateFinished> <dateAdded>2021-05-18</dateAdded> <common_profile_id>525</common_profile_id> <costType>1</costType> <sendToErir>1</sendToErir> <contractID>139</contractID> <okveds></okveds> <markingAdvertiserInfo>ООО Ромашка ОГРН 1231231</markingAdvertiserInfo> </row0> </result> </data> </response>
Другие действия с объектом
Читайте также о других действиях с объектом campaign
:
- добавить кампанию;
- удалить кампанию;
- редактировать кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке;
- добавить контрагента;
- добавить договор.
Чтобы получить данные только по одной кампании, укажите его идентификатор.
Значение по умолчанию: 0 — выводить список всех кампаний.
Фильтр по ID суперкампании.
Фильтрация данных: вывести кампании, созданные после указанной даты.
Формат передачи даты: YYYY-MM-DD
Фильтрация данных: вывести кампании, созданные до указанной даты.
Формат передачи даты: YYYY-MM-DD
Параметр применяется для указания полноты данных в списке кампаний, а также для вывода настроек таргетирования конкретной кампании.
Настройка полноты данных в списке кампаний:
Допустимые значения:
-
common
— краткий вывод:- ID;
- name.
-
short
— сокращенный вывод:- ID;
- name;
- superCampaignID;
- status;
- dateStart;
- dateEnd;
- dateFinished.
-
advanced
— полный вывод.
Значение по умолчанию: advanced
.
Настройка вывода таргетирования конкретной кампании:
actionObjectID
— обязательный параметр.
dateAddedFrom
, dateAddedTo
и search
— запрещены.
Допустимые значения:
-
targetingTime
— таргетирование по времени; -
targetingFrequency
— таргетирование по частоте; -
targetingBehavior
— таргетирование по поведению; -
targetingGeobase
— таргетирование по географии; -
targetingSearch
— таргетирование по поисковым запросам; -
targetingGender
— таргетирование по полу; -
targetingAge
— таргетирование по возрасту; -
targetingRevenue
— таргетирование по доходу; -
targetingUser
— дополнительное таргетирование. Дополнительные параметры: criteriaID и showMode.
Фильтрация по подстроке в имени суперкампании.
Может содержать русские и латинские буквы, цифры и любые символы.
Обязателен только для получения данных по пользовательскому таргетированию ( show=targetingUser).
Идентификатор пользовательской характеристики.
Допустимые значения: от 1 до 63.
Используется только для получения данных по пользовательскому таргетированию (show=targetingUser).
Позволяет выводить список разрешенных и/или запрещенных значений указанной пользовательской характеристики в рекламной кампании.
Допустимые значения:
-
denied
— показать только запрещенные значения; -
allowed
— показать только разрешенные значения; -
all
— показать все значения с разбивкой на разрешенные и запрещенные.
Значение по умолчанию: denied.
Обязательный параметр