targetingFrequency

Таргетировать размещение кампании на площадке по частоте.

  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

Формат запроса

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=campaign
 & action=targetPlace
 & actionObject=targetingFrequency
 & objectID=<integer>
 & placeID=<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>]
Query-параметры
objectID *ID объекта, над которым производится действие.
placeID *

ID площадки.

isRedefined *

Переопределить таргетирование.

Возможные значения:

  • 0 — наследовать настройки таргетирования, установленные на уровне выше. Иерархия уровней от верхнего к нижнему:
    • кампания;
    • размещение кампании на сайте;
    • размещение кампании на разделе сайта;
    • размещение кампании на площадке;
    • баннер.
  • 1 — отменить настройки таргетирования на более высоких уровнях и использовать настройки, установленные на текущем уровне.
maxUniqueImpressions

Частота контакта пользователя с рекламной кампанией. Максимальное количество показов посетителю.

Допустимые значения: целое число от 1 до 2147483647.

maxUniqueClicks

Частота контакта пользователя с рекламной кампанией. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления.

Допустимые значения: целое число от 1 до 2147483647.

datePeriod

Частота контакта пользователя с рекламной кампанией. Дата начала периода, в течение которого действует установленное ограничение показов или переходов.

Формат передачи даты: YYYY-MM-DD

frequencyTypeImpressions

Частота контакта пользователя с рекламной кампанией. Период частоты показов.

Допустимые значения:

  • 0 — не задано;
  • 1 — час;
  • 2 — 4 часа;
  • 3 — 6 часов;
  • 4 — 12 часов;
  • 5 — сутки;
  • 6 — неделя;
  • 7 — месяц;
  • 8 — другой период;
  • 9 — 14 дней.

Значение по умолчанию: 0.

uniquePeriodImpressions

Частота контакта пользователя с рекламной кампанией.

Если период частоты показов выбран как «другой период» (frequencyTypeImpressions=8), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах.

Формат передачи времени: HH:mm

impressionsPerPeriod

Частота контакта пользователя с рекламной кампанией. Количество показов за период.

minimalPeriodImpressions

Частота контакта пользователя с рекламной кампанией. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды).

Формат передачи времени с секундами: HH:mm:ss

frequencyTypeClicks

Частота контакта пользователя с рекламной кампанией. Период частоты переходов.

Допустимые значения:

  • 0 — не задано;
  • 1 — час;
  • 2 — 4 часа;
  • 3 — 6 часов;
  • 4 — 12 часов;
  • 5 — сутки;
  • 6 — неделя;
  • 7 — месяц;
  • 8 — другой период;
  • 9 — 14 дней.

Значение по умолчанию: 0.

uniquePeriodClicks

Частота контакта пользователя с рекламной кампанией.

Если период частоты переходов выбран как «другой период» (frequencyTypeClicks=8), то укажите собственный период. Если в течении периода пользователь произведет по баннеру максимально разрешенное количество кликов, то до конца периода будут ограничены показы баннера этому пользователю.

Формат передачи времени: HH:mm

clicksPerPeriod

Частота контакта пользователя с рекламной кампанией. Количество переходов за период.

Допустимые значения: целое число от 1 до 2147483647.

minimalPeriodClicks

Частота контакта пользователя с рекламной кампанией. Минимальный период между переходами (часы:минуты:секунды).

Формат передачи времени с секундами: HH:mm:ss

*  Обязательный параметр

Формат ответа

<response>
  <status>
    <code>{integer}</code>
  </status>
</response>

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=campaign&action=targetPlace&actionObject=targetingFrequency&objectID=474205&placeID=321&isRedefined=1&maxUniqueImpressions=2

Ответ:

<response>
  <status>
    <code>0</code>
  </status>
</response>

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

См. также другие действия с объектом campaign: