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

`actionObjectID`	Чтобы получить данные только по одному объекту, укажите его ID. Значение по умолчанию: `0` — выводить весь список.
`dateAddedFrom`	Фильтрация данных: вывести суперкампании, созданные после указанной даты.
`dateAddedTo`	Фильтрация данных: вывести суперкампании, созданные до указанной даты.
`show`	Настройка полноты данных в списке кампаний/флайтов. Допустимые значения: `common` — краткий вывод: `ID` `name` `short` — сокращенный вывод: `ID` `bannerTypeID` `templateID` `campaignID` `status` `dateStart` `dateEnd` `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>
     <status>{integer}</status>
     <impressionsMethodID>{integer}</impressionsMethodID>
     <maxImpressions>{integer}</maxImpressions>
     <maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
     <maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
     <maxClicks>{integer}</maxClicks>
     <maxClicksPerDay>{integer}</maxClicksPerDay>
     <maxClicksPerHour>{integer}</maxClicksPerHour>
     <maxUniqueImpressions>{integer}</maxUniqueImpressions>
     <frequencyTypeImpressions>{integer}</frequencyTypeImpressions>
     <uniquePeriodImpressions>{string}</uniquePeriodImpressions>
     <impressionsPerPeriod>{integer}</impressionsPerPeriod>
     <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
     <dateStart>{date}</dateStart>
     <dateEnd>{date}</dateEnd>
     <dateFinished>{date}</dateFinished>
     <dateAdded>{date}</dateAdded>
     <sendToErir>{integer}</sendToErir>
     <contractID>{integer}</contractID>
     <publisherContractID>{integer}</publisherContractID>
     <costType>{integer}</costType>
    </row0>
   </data>
</response>

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

`code`	Статус обработки запроса. Значение `0` — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.
`row0`	Элемент списка с соответствующим номером.
`name`	Название суперкампании.
`advertiserID`	ID рекламодателя.
`advertiserAccount`	Учетная запись рекламодателя.
`assistantID`	ID ассистента, которому приписана суперкампания.
`assistantAccount`	Учетная запись ассистента, которому приписана суперкампания.
`additionalAdvertiserIDs`	ID дополнительных рекламодателей.
`additionalAdvertiserAccounts`	Учетные записи дополнительных рекламодателей.
`additionalAssistantIDs`	ID дополнительных ассистентов.
`additionalAssistantAccounts`	Учетные записи дополнительных ассистентов.
`logicType`	Вид кампании. Для кампании внутри суперкампании не требуется. Допустимые значения: `0` — коммерческая; `1` — промерочная.
`status`	Статус.
`impressionsMethodID`	Методика подсчета показов. Допустимые значения: `0` — загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта. `101≤N≤130`, где `N` — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером. `1101` — видимый показ, Яндекс (IMS). Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее двух секунд. `2101` — показ (IMS). Событие показа, наступающее в момент начала отрисовки (рендеринга) объявлений. `2102` — видимый показ (IMS). Показы объявлений в видимой области окна в активной вкладке браузера, которые учитываются по критериям, установленным международными стандартами медиаиндустрии: минимальный процент пикселей, находящихся в видимой области, и длительность нахождения в видимой области браузера.
`maxImpressions`	Ограничение показов всего.
`maxImpressionsPerDay`	Ограничение показов в сутки.
`maxImpressionsPerHour`	Ограничение показов в час.
`maxClicks`	Ограничение кликов всего.
`maxClicksPerDay`	Ограничение кликов в сутки.
`maxClicksPerHour`	Ограничение кликов в час.
`maxUniqueImpressions`	Максимальное количество показов посетителю.
`frequencyTypeImpressions`	Период частоты показов.
`uniquePeriodImpressions`	Если период частоты показов выбран как `другой период` (`frequencyTypeImpressions`=`8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах.
`impressionsPerPeriod`	Количество показов за период.
`minimalPeriodImpressions`	Минимальный период между показами.
`dateStart`	Дата начала суперкампании.
`dateEnd`	Дата окончания суперкампании.
`dateFinished`	Дата завершения открутки.
`dateAdded`	Дата добавления.
`sendToErir`	Передавать данные в ЕРИР. Допустимые значения: `0` — не передавать данные в ЕРИР; `1` — передавать данные в ЕРИР (маркировка включена).
`contractID`	ID прямого или первичного договора.
`publisherContractID`	ID конечного договора.
`costType`	Тип кампании. Допустимые значения: `0` — другое; `1` — CPM; `2` — CPC; `3` — CPA.

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

Запрос:

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>
     <status>2</status>
     <impressionsMethodID>0</impressionsMethodID>
     <maxImpressions>0</maxImpressions>
     <maxImpressionsPerDay>0</maxImpressionsPerDay>
     <maxImpressionsPerHour>0</maxImpressionsPerHour>
     <maxClicks>0</maxClicks>
     <maxClicksPerDay>0</maxClicksPerDay>
     <maxClicksPerHour>0</maxClicksPerHour>
     <maxUniqueImpressions>0</maxUniqueImpressions>
     <frequencyTypeImpressions>6</frequencyTypeImpressions>
     <uniquePeriodImpressions>0:00</uniquePeriodImpressions>
     <impressionsPerPeriod>1</impressionsPerPeriod>
     <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
     <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>
     <sendToErir>1</sendToErir>
     <contractID>167</contractID>
     <publisherContractID>123</publisherContractID>
     <costType>2</costType>
    </row0>
   </data>
</response>

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

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

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

position

targetingProfile