targetingFrequency
Таргетировать размещение кампании на разделе сайта по частоте.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=campaign
& action=targetZone
& actionObject=targetingFrequency
& objectID=<integer>
& zoneID=<integer>
& isRedefined=<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>]
|
|
ID объекта, над которым производится действие. |
|
|
ID раздела сайта. |
|
|
Переопределить таргетирование. Допустимые значения:
|
|
|
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю. Допустимые значения: целое число от |
|
|
Частота контакта пользователя с рекламной кампанией. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления. Допустимые значения: целое число от |
|
|
Частота контакта пользователя с рекламной кампанией. Дата начала периода, в течение которого действует установленное ограничение показов или переходов. Формат передачи даты: |
|
|
Частота контакта пользователя с рекламной кампанией. Период частоты показов. Допустимые значения:
Значение по умолчанию: |
|
|
Частота контакта пользователя с рекламной кампанией. Если период частоты показов выбран как Формат передачи времени: |
|
|
Частота контакта пользователя с рекламной кампанией. Количество показов за период. |
|
|
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды). Формат передачи времени с секундами: |
|
|
Частота контакта пользователя с рекламной кампанией. Период частоты переходов. Допустимые значения:
Значение по умолчанию: |
|
|
Частота контакта пользователя с рекламной кампанией. Если период частоты переходов выбран как Формат передачи времени: |
|
|
Частота контакта пользователя с рекламной кампанией. Количество переходов за период. Допустимые значения: целое число от |
|
|
Частота контакта пользователя с рекламной кампанией. Минимальный период между переходами (часы:минуты:секунды). Формат передачи времени с секундами: |
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
</response>
Параметры ответа
|
|
Статус обработки запроса. Значение |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=campaign&action=targetZone&actionObject=targetingFrequency&objectID=474205&zoneID=321&isRedefined=1&maxUniqueImpressions=2Ответ:
<response> <status> <code>0</code> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом campaign:
- добавить кампанию
- получить список кампаний;
- удалить кампанию;
- редактировать кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке.
ID объекта, над которым производится действие.
ID раздела сайта.
Переопределить таргетирование.
Допустимые значения:
-
0— наследовать настройки таргетирования, установленные на уровне выше. Иерархия уровней от верхнего к нижнему:- кампания;
- размещение кампании на сайте;
- размещение кампании на разделе сайта;
- размещение кампании на площадке;
- баннер.
-
1— отменить настройки таргетирования на более высоких уровнях и использовать настройки, установленные на текущем уровне.
Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю.
Допустимые значения: целое число от 1 до 2147483647.
Частота контакта пользователя с рекламной кампанией. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления.
Допустимые значения: целое число от 1 до 2147483647.
Частота контакта пользователя с рекламной кампанией. Дата начала периода, в течение которого действует установленное ограничение показов или переходов.
Формат передачи даты: YYYY-MM-DD.
Частота контакта пользователя с рекламной кампанией. Период частоты показов.
Допустимые значения:
0— не задано;1— 1 час;2— 4 часа;3— 6 часов;4— 12 часов;5— сутки;6— неделя;7— месяц;8— другой период;9— 14 дней.
Значение по умолчанию: 0.
Частота контакта пользователя с рекламной кампанией.
Если период частоты показов выбран как другой период (frequencyTypeImpressions=8), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах.
Формат передачи времени: HH:mm.
Частота контакта пользователя с рекламной кампанией. Количество показов за период.
Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды).
Формат передачи времени с секундами: HH:mm:ss.
Частота контакта пользователя с рекламной кампанией. Период частоты переходов.
Допустимые значения:
0— не задано;1— 1 час;2— 4 часа;3— 6 часов;4— 12 часов;5— сутки;6— неделя;7— месяц;8— другой период;9— 14 дней.
Значение по умолчанию: 0.
Частота контакта пользователя с рекламной кампанией.
Если период частоты переходов выбран как другой период (frequencyTypeClicks=8), то укажите собственный период. Если в течение периода пользователь произведет по баннеру максимально разрешенное количество кликов, то показы баннера этому пользователю будут ограничены до конца периода.
Формат передачи времени: HH:mm.
Частота контакта пользователя с рекламной кампанией. Количество переходов за период.
Допустимые значения: целое число от 1 до 2147483647.
Частота контакта пользователя с рекламной кампанией. Минимальный период между переходами (часы:минуты:секунды).
Формат передачи времени с секундами: HH:mm:ss.
Обязательный параметр.