modify
Редактировать параметры суперкампании.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=superCampaign
& action=modify
& objectID=<integer>
& [name=<string>]
& [advertiserID=<integer>]
& [assistantID=<integer>]
& [level=<integer>]
& [priority=<integer>]
& [status=<integer>]
& [sectorID=<integer>]
& [maxImpressions=<integer>]
& [maxImpressionsPerDay=<integer>]
& [maxImpressionsPerHour=<integer>]
& [maxClicks=<integer>]
& [maxClicksPerDay=<integer>]
& [maxClicksPerHour=<integer>]
& [maxActiveEvents=<integer>]
& [maxActiveEventsPerDay=<integer>]
& [maxActiveEventsPerHour=<integer>]
& [maxUniqueImpressions=<integer>]
& [maxUniqueClicks=<integer>]
& [datePeriod=<YYYY-MM-DD>]
& [frequencyTypeImpressions=<integer>]
& [uniquePeriodImpressions=<HH:mm>]
& [impressionsPerPeriod=<integer>]
& [minimalPeriodImpressions=<HH:mm:ss>]
& [frequencyTypeClicks=<integer>]
& [uniquePeriodClicks=<HH:mm>]
& [clicksPerPeriod=<integer>]
& [minimalPeriodClicks=<HH:mm:ss>]
& [dateStart=<YYYY-MM-DD HH:mm>]
& [dateEnd=<YYYY-MM-DD HH:mm>]
|
ID суперкампании, параметры которой необходимо редактировать. |
|
Название суперкампании. Может содержать русские и латинские буквы, цифры и любые символы. |
|
ID рекламодателя. Читайте также: |
|
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа. Читайте также: |
|
Уровень кампании. В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний. Допустимые значения, если модуль «Виды кампаний» выключен:
Значение по умолчанию: Допустимые значения, если модуль «Виды кампаний» включен:
Обратите внимание на зависимость значений параметров |
|
Допустимые значения:
|
|
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный. Допустимые значения:
|
|
Как получить список отраслей, читайте в разделе utility-sector. |
|
Максимальное количество показов баннера. Допустимые значения: |
|
Максимальное количество показов в сутки. Допустимые значения: |
|
Максимальное количество показов в час. Допустимые значения: |
|
Максимальное количество кликов всего. Допустимые значения: |
|
Максимальное количество кликов в сутки. Допустимые значения: |
|
Максимальное количество кликов в час. Допустимые значения: |
|
Максимальное количество активных событий всего. Допустимые значения: |
|
Максимальное количество активных событий в день. Допустимые значения: |
|
Максимальное количество активных событий в час. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Дата начала периода, в течение которого действует установленное ограничение показов или переходов. Формат передачи даты: |
|
Частота контакта пользователя с рекламной кампанией. Период частоты показов. Допустимые значения:
Значение по умолчанию: |
|
Частота контакта пользователя с рекламной кампанией. Если период частоты показов выбран как «другой период» ( Формат передачи времени: |
|
Частота контакта пользователя с рекламной кампанией. Количество показов за период. |
|
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды). Формат передачи времени с секундами: |
|
Частота контакта пользователя с рекламной кампанией. Период частоты переходов. Допустимые значения:
Значение по умолчанию: |
|
Частота контакта пользователя с рекламной кампанией. Если период частоты переходов выбран как «другой период» ( Формат передачи времени: |
|
Частота контакта пользователя с рекламной кампанией. Количество переходов за период. Допустимые значения: |
|
Частота контакта пользователя с рекламной кампанией. Минимальный период между переходами (часы:минуты:секунды). Формат передачи времени с секундами: |
|
Дата начала открутки. Значение по умолчанию: сегодня с 00:00. Формат передачи даты и времени: |
|
Дата окончания открутки. Формат передачи даты и времени: |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Идентификатор редактируемой суперкампании. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=superCampaign&action=modify&objectID=39377&name=April_16_coffee&advertiserID=456&dateStart=2021-12-21 06:30&dateEnd=2021-12-30 22:30
Ответ:
<response> <status> <code>0</code> <ID>39377</ID> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом superCampaign
:
- добавить суперкампанию;
- удалить суперкампанию;
- получить список суперкампаний;
- добавить дополнительного ассистента;
- добавить дополнительного рекламодателя;
- удалить дополнительного ассистента;
- удалить дополнительного рекламодателя.
ID суперкампании, параметры которой необходимо редактировать.
Название суперкампании. Может содержать русские и латинские буквы, цифры и любые символы.
ID рекламодателя.
Читайте также:
ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа.
Читайте также:
Уровень кампании.
В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний.
Допустимые значения, если модуль «Виды кампаний» выключен:
с 1 по 10 включительно
.
Значение по умолчанию: 1
.
Допустимые значения, если модуль «Виды кампаний» включен:
-
с 1 по 10 включительно
— для кампаний вида Гарантия (kind_id=1
). -
11
― для кампаний вида Динамическая монетизация (kind_id=2
). -
с 12 по 20
― для кампаний вида Промо (kind_id=3
).
Обратите внимание на зависимость значений параметров kind_id
и cpm
.
Допустимые значения:
1≤N≤1000
, где N — от 1 до 1000 включительно.
Значение по умолчанию: 100
.
Статус объекта. Могут быть показаны только объекты, находящиеся в статусе активный.
Допустимые значения:
-
0
— активный — объект готов к началу открутки; -
1
— приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе Adfox показывают приостановленные объекты в списке; -
2
— завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе Adfox скрывают завершенные объекты.
Значение по умолчанию: 0
.
Как получить список отраслей, читайте в разделе utility-sector.
Максимальное количество показов баннера.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество показов в час.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов всего.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов в сутки.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество кликов в час.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество активных событий всего.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество активных событий в день.
Допустимые значения: целое число от 1 до 2147483647
.
Максимальное количество активных событий в час.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Дата начала периода, в течение которого действует установленное ограничение показов или переходов.
Формат передачи даты: YYYY-MM-DD
Частота контакта пользователя с рекламной кампанией. Период частоты показов.
Допустимые значения:
-
0
— не задано; -
1
— час; -
2
— 4 часа; -
3
— 6 часов; -
4
— 12 часов; -
5
— сутки; -
6
— неделя; -
7
— месяц; -
8
— другой период; -
9
— 14 дней.
Значение по умолчанию: 0
.
Частота контакта пользователя с рекламной кампанией.
Если период частоты показов выбран как «другой период» (frequencyTypeImpressions=8
), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах.
Формат передачи времени: HH:mm
Частота контакта пользователя с рекламной кампанией. Количество показов за период.
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды).
Формат передачи времени с секундами: HH:mm:ss
Частота контакта пользователя с рекламной кампанией. Период частоты переходов.
Допустимые значения:
-
0
— не задано; -
1
— час; -
2
— 4 часа; -
3
— 6 часов; -
4
— 12 часов; -
5
— сутки; -
6
— неделя; -
7
— месяц; -
8
— другой период; -
9
— 14 дней.
Значение по умолчанию: 0
.
Частота контакта пользователя с рекламной кампанией.
Если период частоты переходов выбран как «другой период» (frequencyTypeClicks=8
), то укажите собственный период. Если в течении периода пользователь произведет по баннеру максимально разрешенное количество кликов, то до конца периода будут ограничены показы баннера этому пользователю.
Формат передачи времени: HH:mm
Частота контакта пользователя с рекламной кампанией. Количество переходов за период.
Допустимые значения: целое число от 1 до 2147483647
.
Частота контакта пользователя с рекламной кампанией. Минимальный период между переходами (часы:минуты:секунды).
Формат передачи времени с секундами: HH:mm:ss
Дата начала открутки.
Значение по умолчанию: сегодня с 00:00.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Дата окончания открутки.
Формат передачи даты и времени: YYYY-MM-DD HH:mm
Обязательный параметр