campaign
Добавить кампанию (флайт).
Формат запроса
https://adfox.yandex.ru/api/v1
? object=account
& action=add
& actionObject=campaign
& name=<string>
& advertiserID=<integer>
& [assistantID=<integer>]
& [superCampaignID=<integer>]
& [impressionsMethodID=<integer>]
& [kind_id=<integer>]
& [level=<integer>]
& [cpm=<integer>]
& [priority=<integer>]
& [status=<integer>]
& [sectorID=<integer>]
& [rotationMethodID=<integer>]
& [trafficPercents=<integer>]
& [commonProfileID=<integer>]
& [targetingProfileID=<integer>]
& [bundleID=<integer>]
& [sequence=<integer>]
& [tracingTypeID=<integer>]
& [isSession=<integer>]
& [outerMarkID=<integer>]
& [isSimplifiedBanners=<integer>]
& [impressionsSmoothTypeID=<integer>]
& [clicksSmoothTypeID=<integer>]
& [maxImpressions=<integer>]
& [maxImpressionsPerDay=<integer>]
& [maxImpressionsPerHour=<integer>]
& [maxClicks=<integer>]
& [maxClicksPerDay=<integer>]
& [dateStart=<YYYY-MM-DD HH:mm>]
& [dateEnd=<YYYY-MM-DD HH:mm>]
& [logicType=<integer>]
& [sendToErir=<integer>]
& [contractID=<integer>]
& [costType=<integer>]
& [okveds[]=<string>]
& [markingAdvertiserInfo=<string>]
|
Название новой рекламной кампании (флайта). Может содержать русские и латинские буквы, цифры и любые символы. |
|
ID рекламодателя. Если кампания добавляется к суперкампании, то рекламодатель не указывается и будет унаследован от суперкампании. Читайте также: |
|
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Если кампания добавляется к суперкампании, то ассистент не указывается и будет унаследован от суперкампании. Читайте также: |
|
ID суперкампании, если кампания добавляется к суперкампании. Читайте также: |
|
Допустимые значения:
|
|
Определяет вид кампании. Допустимые значения:
Значение по умолчанию: |
|
Уровень кампании. В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний. Допустимые значения, если модуль «Виды кампаний» выключен:
Значение по умолчанию: Допустимые значения, если модуль «Виды кампаний» включен:
Обратите внимание на зависимость значений параметров |
|
Пороговое значение CPM для рекламной кампании вида Динамическая монетизация. Для Для Допустимые значения: Если передается CPM, то не передавайте CPC. |
|
Допустимые значения: Значение по умолчанию: |
|
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный. Допустимые значения:
Значение по умолчанию: |
|
Как получить список отраслей, читайте в разделе utility-sector. |
|
Допустимые значения:
Значение по умолчанию: |
|
Процент от трафика. Обязателен, если используется метод ротации по % от трафика ( Допустимые значения: |
|
ID общего профиля. Общий профиль объединяет профиль таргетирования и профиль размещения. При указании общего профиля не нужно передавать |
|
Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности. Как посмотреть список ID профилей, читайте в разделе list-targetingProfile. |
|
Профиль размещения позволяет объединить площадки, на которых часто размещаются кампании. При создании новой кампании, вы можете сразу указать профиль размещения, тогда кампания будет размещена на указанных в профиле площадках. |
|
Группа. |
|
Учет действий. Допустимые значения:
Значение по умолчанию: |
|
Допустимые значения:
Значение по умолчанию: |
|
Включить автоматическую подстановку меток к ссылкам для перехода. Допустимые значения:
Значение по умолчанию: |
|
Упрощенные баннеры (дополнительный модуль). Допустимые значения:
Значение по умолчанию: |
|
Скорость открутки показов. Допустимые значения:
Значение по умолчанию: |
|
Скорость открутки переходов. Допустимые значения:
Значение по умолчанию: |
|
Максимальное количество показов баннера. Допустимые значения: |
|
Максимальное количество показов в сутки. Допустимые значения: |
|
Максимальное количество показов в час. Допустимые значения: |
|
Максимальное количество кликов всего. Допустимые значения: |
|
Максимальное количество кликов в сутки. Допустимые значения: |
|
Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: |
|
Дата окончания открутки. Формат передачи даты и времени: |
|
Вид кампании. Для кампании внутри суперкампании — не требуется. Допустимые значения:
Значение по умолчанию: |
|
Передавать данные в ЕРИР. Допустимые значения:
Значение по умолчанию: |
|
Идентификатор договора. Обязательно для заполнения, если значение |
|
Тип кампании. Допустимые значения:
Значение по умолчанию: |
|
Список с ОКВЭД-ами рекламируемых товаров. Если кодов несколько, передайте их в новом параметре, например: |
|
Информация о рекламодателе в рекламном меню баннера. Отображается, если на баннере включена опция Показывать рекламное меню. По умолчанию — пустая строка. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Идентификатор созданного объекта. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=campaign&name=April_16_tea&advertiserID=456&dateStart=2021-12-20 06:30&dateEnd=2021-12-31 22:30
Ответ:
<response> <status> <code>0</code> <ID>393747</ID> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом campaign
:
- получить список кампаний;
- удалить кампанию;
- редактировать кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке;
- добавить контрагента;
- добавить договор.
Название новой рекламной кампании (флайта). Может содержать русские и латинские буквы, цифры и любые символы.
ID рекламодателя.
Если кампания добавляется к суперкампании, то рекламодатель не указывается и будет унаследован от суперкампании.
Читайте также:
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа.
Если кампания добавляется к суперкампании, то ассистент не указывается и будет унаследован от суперкампании.
Читайте также:
ID суперкампании, если кампания добавляется к суперкампании.
Читайте также:
Допустимые значения:
-
0
— загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта; -
101≤N≤130
, где N — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером; -
1101
— видимый показ, Яндекс (IMS). Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее двух секунд; -
2101
— показ (IMS). Событие показа, наступающее в момент начала отрисовки (рендеринга) объявлений; -
2102
— видимый показ (IMS). Показы объявлений в видимой области окна в активной вкладке браузера, которые учитываются по критериям, установленным международными стандартами медиаиндустрии: минимальный % пикселей, находящихся в видимой области, и длительность нахождения в видимой области браузера.
Определяет вид кампании.
Допустимые значения:
-
1
— вид Гарантия, используется для кампаний с гарантированными продажами, по которым есть обязательства по открутке. Включает зависимость двух параметров:level
может принимать значения только в диапазоне от 1 до 10. Еслиlevel
не передан, будет установлено значение по умолчанию —1
.cpm
не требуется. Если параметр был передан, то его значение игнорируется.
-
2
— вид Динамическая монетизация, дает возможность издателю получать наибольший доход от показа, разрешая Рекламной сети Яндекса конкурировать за показы негарантированных рекламных кампаний. Приоритезация кампаний происходит по CPM. Включает зависимость двух параметров:level
должен быть равен 11. Еслиlevel
не передан, будет установлено значение по умолчанию —11
.cpm
обязателен и должен быть> 0
.
Если рекламная кампания создана с внешним монетизатором, то изменять «Вид кампании» нельзя. Он должен быть равен значению
2
. -
3
— вид Промо, используется для кампаний собственного промоутирования, заглушек. Включает зависимость двух параметров:level
может принимать значения только в диапазоне от 12 до 20. Еслиlevel
не передан, будет установлено значение по умолчанию12
.cpm
не требуется. Если параметр был передан, то его значение игнорируется.
Значение по умолчанию: 1
.
Уровень кампании.
В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний.
Допустимые значения, если модуль «Виды кампаний» выключен:
с 1 по 10 включительно.
Значение по умолчанию: 1
.
Допустимые значения, если модуль «Виды кампаний» включен:
-
с 1 по 10 включительно
— для кампаний вида Гарантия (kind_id=1
). -
11
— для кампаний вида Динамическая монетизация (kind_id=2
). -
с 12 по 20
— для кампаний вида Промо (kind_id=3
).
Обратите внимание на зависимость значений параметров kind_id
и cpm
.
Пороговое значение CPM для рекламной кампании вида Динамическая монетизация.
Для kind_id=2
— обязательный параметр.
Для kind_id=1|3
— необязательный, но если передается, то значение игнорируется.
Допустимые значения: целое число от 1 до 99 999
.
Если передается CPM, то не передавайте CPC.
Допустимые значения: 1≤N≤1000
, где N — от 1 до 1000 включительно.
Значение по умолчанию: 100
.
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный.
Допустимые значения:
-
0
— активный — объект готов к началу открутки; -
1
— приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе Adfox показывают приостановленные объекты в списке; -
2
— завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе Adfox скрывают завершенные объекты.
Значение по умолчанию: 0
.
Как получить список отраслей, читайте в разделе utility-sector.
Допустимые значения:
-
0
— по приоритетности — использовать значения параметровlevel
иpriority
для оценки вероятности показа рекламной кампании; -
1 — по % от трафика — использовать значение параметра
trafficPercents
для оценки вероятности показа рекламной кампании. ПараметрtrafficPercents
обязателен.
Значение по умолчанию: 0
.
Процент от трафика.
Обязателен, если используется метод ротации по % от трафика (rotationMethodID=1
).
Допустимые значения: от 1 до 100
.
ID общего профиля.
Общий профиль объединяет профиль таргетирования и профиль размещения. При указании общего профиля не нужно передавать targetingProfileID
и bundleID
.
Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности.
Как посмотреть список ID профилей, читайте в разделе list-targetingProfile.
Профиль размещения позволяет объединить площадки, на которых часто размещаются кампании. При создании новой кампании, вы можете сразу указать профиль размещения, тогда кампания будет размещена на указанных в профиле площадках.
Группа.
Учет действий.
Допустимые значения:
-
0
— не вести учет действий пользователя на сайте рекламодателя; -
1
— postClick — считать количество загрузок точек учета действия в течение суток с момента перехода по рекламному объявлению; -
2
— postClick и postView — считать количество загрузок точек учета действия как после переход, так и после просмотра рекламного объявления; -
3
— postView — считать количество загрузок точек учета действия после просмотра рекламного объявления или после суток с момента перехода по рекламному объявлению.
Значение по умолчанию: 0
.
Допустимые значения:
-
0
— выключено; -
1
— включено.
Значение по умолчанию: 0
.
Включить автоматическую подстановку меток к ссылкам для перехода.
Допустимые значения:
-
0
— выключено; -
1
— Openstat.ru; -
2
— Google Analytics.
Значение по умолчанию: 0
.
Упрощенные баннеры (дополнительный модуль).
Допустимые значения:
-
0
— выключено; -
1
— включено.
Значение по умолчанию: 0
.
Скорость открутки показов.
Допустимые значения:
-
0
— максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по показам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании. -
1
— равномерное распределение суточного ограничения. Показы будут равномерно распределены в течение суток. Обязательно укажите максимальное количество показов в сутки (maxImpressionsPerDay
). -
2
— равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Обязательно укажите максимальное количество показов (maxImpressions
) и дату окончания (dateEnd
) для рекламной кампании. -
3
— равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если на момент завершения кампании по дате окончания еще остались невыполненные показы, то кампания автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью. Обязательно укажите максимальное количество показов (maxImpressions
) и дату окончания (dateEnd
) для рекламной кампании.
Значение по умолчанию: 0
.
Скорость открутки переходов.
Допустимые значения:
-
0
— максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по переходам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании. -
1
— равномерное распределение суточного ограничения. Показы будут равномерно распределены в течение суток. Обязательно укажите максимальное количество переходов в сутки (maxClicksPerDay
). -
2
— равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Обязательно укажите максимальное количество переходов (maxClicks
) и дату окончания (dateEnd
) для рекламной кампании. -
3
— равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если на момент завершения кампании по дате окончания еще остались невыполненные переходы, то кампания автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью. Обязательно укажите максимальное количество переходов (maxClicks
) и дату окончания (dateEnd
) для рекламной кампании.
Значение по умолчанию: 0
.
Максимальное количество показов баннера.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в час.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов всего.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Дата начала открутки.
Значение по умолчанию: сегодня с 00:00.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Дата окончания открутки.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Вид кампании. Для кампании внутри суперкампании — не требуется.
Допустимые значения:
-
0
— коммерческая; -
1
— промерочная.
Значение по умолчанию: 0
.
Передавать данные в ЕРИР.
Допустимые значения:
-
0
— не передавать данные в ЕРИР; -
1
— передавать данные в ЕРИР (маркировка включена).
Значение по умолчанию: 0
.
Идентификатор договора. Обязательно для заполнения, если значение sendToErir=1
. Подробнее о получении списка договоров.
Тип кампании.
Допустимые значения:
-
0
— другое; -
1
— CPM; -
2
— CPC; -
3
— CPA.
Значение по умолчанию: 0
.
Список с ОКВЭД-ами рекламируемых товаров. Если кодов несколько, передайте их в новом параметре, например: &okveds[]=88.33&okveds[]=77.54
.
Информация о рекламодателе в рекламном меню баннера. Отображается, если на баннере включена опция Показывать рекламное меню. По умолчанию — пустая строка.
Обязательный параметр