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

`actionObjectID`	Чтобы получить данные только по одной кампании, укажите его идентификатор. Значение по умолчанию: `0` — выводить список всех кампаний.
`superCampaignID`	Фильтр по ID суперкампании.
`dateAddedFrom`	Фильтрация данных: вывести кампании, созданные после указанной даты. Формат передачи даты: `YYYY-MM-DD`
`dateAddedTo`	Фильтрация данных: вывести кампании, созданные до указанной даты. Формат передачи даты: `YYYY-MM-DD`
`show`	Параметр применяется для указания полноты данных в списке кампаний, а также для вывода настроек таргетирования конкретной кампании. Настройка полноты данных в списке кампаний: Допустимые значения: `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.
`search`	Фильтрация по подстроке в имени суперкампании. Может содержать русские и латинские буквы, цифры и любые символы.
`criteriaID`	Обязателен только для получения данных по пользовательскому таргетированию ( show=targetingUser). Идентификатор пользовательской характеристики. Допустимые значения: от `1` до `63`.
`showMode`	Используется только для получения данных по пользовательскому таргетированию (show=targetingUser). Позволяет выводить список разрешенных и/или запрещенных значений указанной пользовательской характеристики в рекламной кампании. Допустимые значения: `denied` — показать только запрещенные значения; `allowed` — показать только разрешенные значения; `all` — показать все значения с разбивкой на разрешенные и запрещенные. Значение по умолчанию: `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>
    <priority>{integer}</priority>
    <targetingProfileID>{integer}</targetingProfileID>
    <isSession>{integer}</isSession>
    <impressionsMethodID>{integer}</impressionsMethodID>
    <impressionsSmoothTypeID>{integer}</impressionsSmoothTypeID>
    <kind_id>{integer}</kind_id>
    <sectorID>{integer}</sectorID>
    <rotationMethodID>{integer}</rotationMethodID>
    <trafficPercents>{integer}</trafficPercents>
    <logicType>{integer}</logicType>
    <cpm>{integer}</cpm>
    <cpc>{integer}</cpc>
    <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>
    <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>
      <publisherContractID>{integer}</publisherContractID>
      <markingAdvertiserInfo>{string}</markingAdvertiserInfo>
  </row0>
</result>
</data>
</response>

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

`code`	Статус обработки запроса. Значение `0` — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.
`rows`	Количество элементов в дереве ответа.
`rowN`	Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе).
`ID`	Уникальный идентификатор кампании.
`name`	Название кампании.
`superCampaignID`	ID суперкампании, которой принадлежит кампания.
`superCampaignName`	Название суперкампании, которой принадлежит кампания.
`advertiserID`	ID рекламодателя.
`advertiserAccount`	Учетная запись рекламодателя.
`assistantID`	ID ассистента, которому приписана кампания.
`assistantAccount`	Учетная запись ассистента, которому приписана кампания.
`additionalAdvertiserIDs`	ID дополнительных рекламодателей.
`additionalAdvertiserAccounts`	Учетные записи дополнительных рекламодателей.
`additionalAssistantIDs`	ID дополнительных ассистентов.
`additionalAssistantAccounts`	Учетные записи дополнительных ассистентов.
`level`	Уровень кампании.
`priority`	Приоритет кампании.
`status`	Статус. Возможные значения: `0` — активный; `1` — приостановленный; `2` — завершенный.
`type`	Устаревший параметр. Тип кампании. Возможные значения: `0` — упрощенная; `1` — стандартная.
`tracingPointsType`	Устаревший параметр. Учет действий. Возможные значения: `0` – нет; `1` – postClick; `2` – postView & postClick; `3` – postView.
`targetingProfileID`	ID профиля таргетирования.
`isSession`	Сессионные показы. Возможные значения: `0` — выключены; `1` — включены.
`bannerSequence`	Устаревший параметр. Последовательность показов баннеров. Возможные значения: `0` — весовая. Выбор баннера осуществляется на основании его приоритета; `1` — по сценарию (параметр «Период сценария» (scenarioPeriodID) становится обязательным). Сценарий представляет собой указание для баннера порядкового номера и количества его показов пользователю.
`scenarioPeriodID`	Устаревший параметр. Период сценария — определяет периодичность повтора показов баннеров этой рекламной кампании для уникального пользователя. Обязателен, если последовательность показа — по сценарию (`bannerSequence=1`). Возможные значения: `0` — однократный сценарий; `1` — 1 час; `2` — 4 часа; `3` — 6 часов; `4` — 12 часов; `5` — 1 день; `6` — 1 неделя; `7` — 1 месяц; `11` — постоянное повторение сценария.
`impressionsMethodID`	Методика подсчета показов. Возможные значения: `0` — загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта; `101≤N≤130`, где N — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером; `1101` — видимый показ, Яндекс (IMS). Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее двух секунд; `2101` — показ (IMS). Событие показа, наступающее в момент начала отрисовки (рендеринга) объявлений; `2102` — видимый показ (IMS). Показы объявлений в видимой области окна в активной вкладке браузера, которые учитываются по критериям, установленным международными стандартами медиаиндустрии: минимальный % пикселей, находящихся в видимой области, и длительность нахождения в видимой области браузера.
`impressionsSmoothTypeID`	Скорость открутки показов. Возможные значения: `0` — максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по показам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании. `1` — равномерное распределение суточного ограничения. Показы будут равномерно распределены в течении суток. Обязательно укажите максимальное количество показов в сутки (`maxImpressionsPerDay`); `2` — равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании; `3` — равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если кампания за отведенное время не выкрутила свое ограничение, то она автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании.
`kind_id`	Определяет вид кампании. Возможные значения: `1` — вид Гарантия, используется для кампаний с гарантированными продажами, по которым есть обязательства по открутке. `2` — вид Динамическая монетизация. `3` — вид Промо, используется для кампаний собственного промоутирования, заглушек.
`sectorID`	Отрасль. Как получить список отраслей, читайте в разделе utility-sector.
`rotationMethodID`	Метод ротации кампании. Возможные значения: `0` — по приоритетности; `1` — по % от трафика.
`trafficPercents`	Процент от трафика.
`logicType`	Вид кампании. Возможные значения: `0` — коммерческая; `1` — промерочная.
`cpm`	Пороговое значение CPM для рекламной кампании вида Динамическая монетизация.
`cpc`	Пороговое значение CPC для рекламной кампании вида Динамическая монетизация.
`clicksSmoothTypeID`	Скорость открутки переходов. Возможные значения: `0` — максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по переходам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании. `1` — равномерное распределение суточного ограничения. Показы будут равномерно распределены в течении суток. Обязательно укажите максимальное количество переходов в сутки (`maxClicksPerDay`); `2` — равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Обязательно укажите максимальное количество переходов (`maxClicks`) и дату окончания (`dateEnd`) для рекламной кампании; `3` — равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если кампания за отведенное время не выкрутила свое ограничение, то она автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью. Обязательно укажите максимальное количество переходов (`maxClicks`) и дату окончания (`dateEnd`) для рекламной кампании.
`maxImpressions`	Максимальное количество показов.
`impressionsAll`	Показания счетчиков. Показов всего.
`maxImpressionsPerDay`	Максимальное количество показов в сутки.
`impressionsToday`	Показания счетчиков. Показов в текущие сутки.
`maxImpressionsPerHour`	Максимальное количество показов в час.
`impressionsPerHour`	Показания счетчиков. Показов в текущий час.
`maxClicks`	Максимальное кликов всего.
`clicksAll`	Показания счетчиков. Кликов всего.
`maxClicksPerDay`	Максимальное количество кликов в сутки.
`clicksToday`	Показания счетчиков. Кликов в текущие сутки.
`maxClicksPerHour`	Максимальное количество кликов в час.
`clicksPerHour`	Показания счетчиков. Кликов в текущий час.
`dateStart`	Дата начала открутки.
`dateEnd`	Дата окончания открутки.
`dateFinished`	Дата завершения открутки.
`dateAdded`	Дата добавления.
`common_profile_id`	Идентификатор общего профиля для `show=advanced`.
`costType`	Тип кампании. Возможные значения: `0` — другое; `1` — CPM. `2` — CPC. `3` — CPA.
`sendToErir`	Передавать данные в ЕРИР. Возможные значения: `0` — не передавать данные в ЕРИР; `1` — передавать данные в ЕРИР (маркировка включена).
`contractID`	Идентификатор прямого или первичного договора.
`publisherContractID`	Идентификатор конечного договора.
`okveds`	Устаревший параметр. ОКВЭД рекламируемого товара.
`markingAdvertiserInfo`	Информация о рекламодателе в рекламном меню баннера.

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

Запрос:

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>
    <priority>100</priority>
    <targetingProfileID>0</targetingProfileID>
    <isSession>0</isSession>
    <impressionsMethodID>0</impressionsMethodID>
    <impressionsSmoothTypeID>0</impressionsSmoothTypeID>
    <kind_id>0</kind_id>
    <sectorID>0</sectorID>
    <rotationMethodID>0</rotationMethodID>
    <trafficPercents>0</trafficPercents>
    <logicType>0</logicType>
    <cpm>0</cpm>
    <cpc>0</cpc>
    <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>
    <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>
    <publisherContractID>50</publisherContractID>
    <markingAdvertiserInfo>ООО Ромашка ОГРН 1231231</markingAdvertiserInfo>
  </row0>
</result>
</data>
</response>

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

Читайте также о других действиях с объектом campaign:

добавить кампанию;
удалить кампанию;
редактировать кампанию;
получить список баннеров рекламной кампании;
разместить кампанию на сайте, разделе, площадке;
добавить контрагента;
добавить договор.

Была ли статья полезна?

bannerType