superCampaign

Добавить суперкампании. Суперкампания — это объект, объединяющий несколько рекламных кампаний. Суперкампании позволяют производить размещение нескольких кампаний с кросс-частотой по разным площадкам и получать отчеты по пересечению аудитории кампаний.

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

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=add
 & actionObject=superCampaign
 & name=<string>
 & advertiserID=<integer>
 & [assistantID=<integer>]
 & [impressionsMethodID=<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>]
 & [pricingModel=<integer>]
 & [itemCost=<integer>]
 & [itemQty=<integer>]
 & [dateStart=<YYYY-MM-DD HH:mm>]
 & [dateEnd=<YYYY-MM-DD HH:mm>]
Query-параметры
name *Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
advertiserID *

ID рекламодателя.

См. также:

assistantID

ID ассистента, которому будет разрешен доступ к объекту в соответствии с его правами доступа.

См. также:

impressionsMethodID

Методика подсчета показов.

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

  • −1 — не переопределено. Значение наследуется из настроек аккаунта и применяется ко всем кампаниям;
  • 0 — загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта;
  • 1001 — видимый показ. Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее 2 секунд;
  • 101≤N≤130, где N — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером.
level

Уровень кампании.

В зависимости от подключения в аккаунте модуля «Виды кампаний», будет доступно разное количество уровней для рекламных кампаний.

Допустимые значения, если модуль «Виды кампаний» выключен:

  • с 1 по 10 включительно

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

Допустимые значения, если модуль «Виды кампаний» включен:

  • с 1 по 10 включительно — для кампаний вида «Гарантия» (kind_id=1).
  • 11 - для кампаний вида «Динамическая монетизация» (kind_id=2).
  • с 12 по 20 - для кампаний вида «Промо» (kind_id=3).

Обратите внимание на зависимость значений параметров kind_id и cpm.

priority

Приоритет.

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

  • 1≤N≤1000, где N — от 1 до 1000 включительно.

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

status

Статус объекта. Могут быть показаны только объекты, находящиеся в статусе «активный».

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

  • 0 — активный — объект готов к началу открутки;
  • 1 — приостановленный — предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе ADFOX показывают приостановленные объекты в списке;
  • 2 — завершенный — предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе ADFOX скрывают завершенные объекты.

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

sectorID

Отрасль.

См. также:

maxImpressions

Максимальное количество показов баннера.

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

maxImpressionsPerDay

Максимальное количество показов в сутки.

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

maxImpressionsPerHour

Максимальное количество показов в час.

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

maxClicks

Максимальное количество кликов всего.

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

maxClicksPerDay

Максимальное количество кликов в сутки.

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

maxClicksPerHour

Максимальное количество кликов в час.

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

maxActiveEvents

Максимальное количество активных событий всего.

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

maxActiveEventsPerDay

Максимальное количество активных событий в день.

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

maxActiveEventsPerHour

Максимальное количество активных событий в час.

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

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

pricingModel

Для продукта ADFOX.Nets.

Финансовые показатели размещения. Модель ценообразования:

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

  • 0 — не задано;
  • 1 — статика (стоимость за сутки);
  • 2 — CPM (стоимость за 1000 показов);
  • 3 — CPC (стоимость за 1 клик);
  • 4 — CPA (стоимость за 1 действие).

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

itemCost

Для продукта ADFOX.Nets.

Финансовые показатели размещения. Стоимость единицы.

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

itemQty

Для продукта ADFOX.Nets.

Финансовые показатели размещения. Количество единиц.

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

dateStart

Дата начала открутки.

Значение по умолчанию: сегодня с 00:00.

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

dateEnd

Дата окончания открутки.

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

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

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

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

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

code

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

ID

Идентификатор объекта.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=account&action=add&actionObject=superCampaign&name=April_16_tea&advertiserID=456&dateStart=2016-12-20 06:30&dateEnd=2016-12-31 22:30

Ответ:

<response>
<status>
  <code>0</code>
  <ID>39377</ID>
</status>
</response>

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

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