place

Добавить площадку.

Если к аккаунту в ADFOX подключены продукты: ADFOX.Sites, ADFOX.Mobile, или ADFOX.Exchange, то необходимо использовать методы: website, zone, place (так как в системе используются объекты «сайт», «раздел» и «площадка» для разметки площадок и размещения баннеров).

Если к аккаунту в ADFOX подключен продукт ADFOX.Nets — adNetwork, adNetworkWebsite (так как в системе используются объекты «рекламная сеть» и «сайт рекламной сети» для разметки площадок и размещения баннеров).

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

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=account
 & action=add
 & actionObject=place
 & name=<string>
 & siteID=<integer>
 & zoneID=<integer>
 & bannerTypeID=<integer>
 & positionID=<integer>
 & [categoryID=<integer>]
 & [pct=<integer>]
 & [plp=<integer>]
 & [pli=<integer>]
 & [pop=<integer>]
Query-параметры
name *Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
siteID *

ID сайта, в котором создается площадка.

См. также:

zoneID *

ID раздела, в котором создается площадка.

См. также:

bannerTypeID *

ID типа баннера, с которым создается площадка.

См. также:

positionID *

ID расположения площадки.

См. также:

categoryID

ID категории.

См. также:

pct

Настройка, разрешающая показы определенных типов рекламных кампаний на данной площадке.

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

  • 0из URL запроса (по умолчанию) — тип кода определяется значением параметра, полученного из URL запроса за баннером. Если в запросе значение не было передано, по умолчанию площадка считается с типом кода обычный;
  • 1обычный — разрешены к показу баннеры из всех рекламных кампаний, кроме кампаний с типом «сессионные на странице»;
  • 2неповторяющиеся баннеры — на странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано для показа несколько разных баннеров, кроме кампаний с типом «сессионные на странице»;
  • 3сессионный на странице — разрешены к показу баннеры из рекламных кампаний, отмеченных как «сессионная на странице» (имеют приоритет перед обычными кампаниями), если сессионных кампаний для показа нет, будет выбрана для показа обычная рекламная кампания;
  • 4неповторяющиеся кампании — на странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано по одному баннеру из одной рекламной кампании, кроме кампаний с типом «сессионные на странице».
plp

Ограничение по частоте показов на уровне площадки. Период частоты показов.

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

  • -1из URL запроса (по умолчанию) — настройки ограничения показов будут использоваться из параметров URL запроса за баннером. Если в запросе значения не были переданы, то считается, что площадка без ограничений. Параметры pli (Количество показов за период) и pop (Другой период) должны быть пустыми или отсутствовать в запросе;
  • 0без ограничений — показы баннеров на данной площадке не ограничиваются, даже если в параметрах запроса указано иное. Параметры pli (Количество показов за период) и pop (Другой период) должны быть пустыми или отсутствовать в запросе;
  • 11 час — ограничение действует 1 час с момента первого показа баннера уникальному пользователю;
  • 26 часов — ограничение действует 6 часов с момента первого показа баннера уникальному пользователю;
  • 312 часов — ограничение действует 12 часов с момента первого показа баннера уникальному пользователю.
  • 424 часа — ограничение действует 24 часа с момента первого показа баннера уникальному пользователю.
  • 5другой — собственный период действия ограничения показов в минутах. Параметр pop (Другой период) является обязательным.
pli

Ограничение по частоте показов на уровне площадки. Количество показов за период, определяющее сколько показов баннеров на этой площадке будет совершено для уникального пользователя.

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

Если plp=-1 или plp=0 (параметр «Период частоты показов» передается со значением «из URL запроса» или «без ограничений»), то параметр pli должен отсутствовать в запросе или передаваться с пустым значением.

pop

Ограничение по частоте показов на уровне площадки. Другой период (минуты) - собственный период действия ограничения показов в минутах.

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

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

Обязателен, если plp=5 (Период частоты показов = другой).

Если plp=-1 или plp=0 (параметр «Период частоты показов» передается со значением «из URL запроса» или «без ограничений»), то параметр pop должен отсутствовать в запросе или передаваться с пустым значением.

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

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

<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=place&name=site.ru&siteID=39939&zoneID=84438&bannerTypeID=22&positionID=2

Ответ:

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

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

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