superCampaign
Добавить суперкампании. Суперкампания — это объект, объединяющий несколько рекламных кампаний. Суперкампании позволяют производить размещение нескольких кампаний с кросс-частотой по разным площадкам и получать отчеты по пересечению аудитории кампаний.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=account
& action=add
& actionObject=superCampaign
& name=<string>
& advertiserID=<integer>
& [assistantID=<integer>]
& [impressionsMethodID=<integer>]
& [status=<integer>]
& [sectorID=<integer>]
& [maxImpressions=<integer>]
& [maxImpressionsPerDay=<integer>]
& [maxImpressionsPerHour=<integer>]
& [maxClicks=<integer>]
& [maxClicksPerDay=<integer>]
& [maxClicksPerHour=<integer>]
& [maxUniqueImpressions=<integer>]
& [frequencyTypeImpressions=<integer>]
& [uniquePeriodImpressions=<HH:mm>]
& [impressionsPerPeriod=<integer>]
& [minimalPeriodImpressions=<HH:mm:ss>]
& [dateStart=<YYYY-MM-DD HH:mm>]
& [dateEnd=<YYYY-MM-DD HH:mm>]
& [sendToErir=<integer>]
& [contractID=<integer>]
& [publisherContractID=<integer>]
& [costType=<integer>]
|
Название объекта. Может содержать русские и латинские буквы, цифры и любые символы. |
|
ID рекламодателя. Читайте также: |
|
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Читайте также: |
|
Методика подсчета показов. Допустимые значения:
|
|
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный. Допустимые значения:
Значение по умолчанию: |
|
Как получить список отраслей, читайте в разделе utility-sector. |
|
Максимальное количество показов баннера. Допустимые значения: |
|
Максимальное количество показов в сутки. Допустимые значения: |
|
Максимальное количество показов в час. Допустимые значения: |
|
Максимальное количество кликов всего. Допустимые значения: |
|
Максимальное количество кликов в сутки. Допустимые значения: |
|
Максимальное количество кликов в час. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Период частоты показов. Допустимые значения:
Значение по умолчанию: |
|
Частота контакта пользователя с рекламной кампанией.
Если период частоты показов выбран как «другой период» ( Формат передачи времени: |
|
Частота контакта пользователя с рекламной кампанией. Количество показов за период. |
|
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды). Формат передачи времени с секундами: |
|
Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: |
|
Дата окончания открутки. Формат передачи даты и времени: |
|
Передавать данные в ЕРИР. Возможные значения:
|
|
Идентификатор прямого или первичного договора. Обязательно для заполнения, если значение |
|
Идентификатор конечного договора. Обязательный параметр, если в |
|
Тип кампании. Возможные значения:
Значение по умолчанию: |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Идентификатор созданного объекта. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=superCampaign&name=April_16_tea&advertiserID=456&dateStart=2021-12-20 06:30&dateEnd=2021-12-31 22:30
Ответ:
<response> <status> <code>0</code> <ID>39377</ID> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом superCampaign
:
- редактировать суперкампанию;
- удалить суперкампанию;
- получить список суперкампаний;
- добавить дополнительного ассистента;
- добавить дополнительного рекламодателя;
- удалить дополнительного ассистента;
- удалить дополнительного рекламодателя.
Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
ID рекламодателя.
Читайте также:
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа.
Читайте также:
Допустимые значения:
-
0
— загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта; -
101≤N≤130
, где N — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером; -
1101
— видимый показ, Яндекс (IMS). Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее двух секунд; -
2101
— показ (IMS). Событие показа, наступающее в момент начала отрисовки (рендеринга) объявлений; -
2102
— видимый показ (IMS). Показы объявлений в видимой области окна в активной вкладке браузера, которые учитываются по критериям, установленным международными стандартами медиаиндустрии: минимальный % пикселей, находящихся в видимой области, и длительность нахождения в видимой области браузера.
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный.
Допустимые значения:
-
0
— активный — объект готов к началу открутки; -
1
— приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе Adfox показывают приостановленные объекты в списке; -
2
— завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе Adfox скрывают завершенные объекты.
Значение по умолчанию: 0
.
Как получить список отраслей, читайте в разделе utility-sector.
Максимальное количество показов баннера.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в час.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов всего.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов в час.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Период частоты показов.
Допустимые значения:
0
— не задано;
1
— час;
2
— 4 часа;
3
— 6 часов;
4
— 12 часов;
5
— сутки;
6
— неделя;
7
— месяц;
8
— другой период;
9
— 14 дней.
Значение по умолчанию: 0
.
Частота контакта пользователя с рекламной кампанией.
Если период частоты показов выбран как «другой период» (frequencyTypeImpressions=8
), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах.
Формат передачи времени: HH:mm
Частота контакта пользователя с рекламной кампанией. Количество показов за период.
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды).
Формат передачи времени с секундами: HH:mm:ss
Дата начала открутки.
Значение по умолчанию: сегодня с 00:00.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Дата окончания открутки.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Передавать данные в ЕРИР.
Допустимые значения:
-
0
— не передавать данные в ЕРИР; -
1
— передавать данные в ЕРИР (маркировка включена).
Идентификатор прямого или первичного договора.
Обязательно для заполнения, если значение sendToErir=1
. Подробнее о получении списка договоров.
Идентификатор конечного договора.
Обязательный параметр, если в contractID
указан первичный договор.
Тип кампании.
Допустимые значения:
-
0
— другое; -
1
— CPM; -
2
— CPC; -
3
— CPA.
Значение по умолчанию: 0
.
Обязательный параметр