place
Добавить площадку.
Формат запроса
https://adfox.yandex.ru/api/v1
? 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>]
|
Название объекта. Может содержать русские и латинские буквы, цифры и любые символы. |
|
ID сайта, в котором создается площадка. Читайте также: |
|
ID раздела, в котором создается площадка. Читайте также: |
|
ID типа баннера, с которым создается площадка. Читайте также: |
|
ID расположения площадки. Читайте также: |
|
ID категории. Читайте также: |
|
Настройка, разрешающая показы определенных типов рекламных кампаний на данной площадке. Допустимые значения:
|
|
Ограничение по частоте показов на уровне площадки. Период частоты показов. Допустимые значения:
|
|
Ограничение по частоте показов на уровне площадки. Количество показов за период, определяющее сколько показов баннеров на этой площадке будет совершено для уникального пользователя. Допустимые значения: Если |
|
Ограничение по частоте показов на уровне площадки. Другой период (минуты) — собственный период действия ограничения показов в минутах. Допустимые значения: Значение по умолчанию: Обязателен, если Если |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Идентификатор созданного объекта. |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?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
:
- удалить площадку;
- добавить баннер по умолчанию;
- получить список площадок;
- получить список размещенных на площадке активных баннеров;
- редактировать параметры площадки;
- получить код вставки с уровня площадки.
Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
ID сайта, в котором создается площадка.
Читайте также:
ID раздела, в котором создается площадка.
Читайте также:
ID типа баннера, с которым создается площадка.
Читайте также:
ID расположения площадки.
Читайте также:
ID категории.
Читайте также:
Настройка, разрешающая показы определенных типов рекламных кампаний на данной площадке.
Допустимые значения:
-
0
— из URL запроса (по умолчанию) — тип кода определяется значением параметра, полученного из URL запроса за баннером. Если в запросе значение не было передано, по умолчанию площадка считается с типом кода обычный; -
1
— обычный — разрешены к показу баннеры из всех рекламных кампаний, кроме кампаний с типом сессионные на странице. -
2
— неповторяющиеся — на странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано для показа несколько разных баннеров, кроме кампаний с типом сессионные на странице; -
3
— сессионный на странице — разрешены к показу баннеры из рекламных кампаний, отмеченных как сессионные на странице (имеют приоритет перед обычными кампаниями), если сессионных кампаний для показа нет, будет выбрана для показа обычная рекламная кампания; -
4
— неповторяющиеся кампании — на странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано по одному баннеру из одной рекламной кампании, кроме кампаний с типом сессионные на странице.
Ограничение по частоте показов на уровне площадки. Период частоты показов.
Допустимые значения:
-
-1
— из URL запроса (по умолчанию) — настройки ограничения показов будут использоваться из параметров URL запроса за баннером. Если в запросе значения не были переданы, то считается, что площадка без ограничений. Параметрыpli
(количество показов за период) иpop
(другой период) должны быть пустыми или отсутствовать в запросе; -
0
— без ограничений — показы баннеров на данной площадке не ограничиваются, даже если в параметрах запроса указано иное. Параметрыpli
(количество показов за период) иpop
(другой период) должны быть пустыми или отсутствовать в запросе; -
1
— один час — ограничение действует один час с момента первого показа баннера уникальному пользователю; -
2
— шесть часов — ограничение действует шесть часов с момента первого показа баннера уникальному пользователю; -
3
— 12 часов — ограничение действует 12 часов с момента первого показа баннера уникальному пользователю. -
4
— 24 часа — ограничение действует 24 часа с момента первого показа баннера уникальному пользователю. -
5
— другой — собственный период действия ограничения показов в минутах. Параметрpop
(другой период) является обязательным.
Ограничение по частоте показов на уровне площадки. Количество показов за период, определяющее сколько показов баннеров на этой площадке будет совершено для уникального пользователя.
Допустимые значения: целое число > 1
.
Если plp=-1
или plp=0
(параметр Период частоты показов
передается со значением из URL запроса
или без ограничений
), то параметр pli
должен отсутствовать в запросе или передаваться с пустым значением.
Ограничение по частоте показов на уровне площадки. Другой период (минуты) — собственный период действия ограничения показов в минутах.
Допустимые значения: целое число > 1
.
Значение по умолчанию: 1
.
Обязателен, если plp=5
(период частоты показов = другой
).
Если plp=-1
или plp=0
(параметр Период частоты показов
передается со значением из URL запроса
или без ограничений
), то параметр pop
должен отсутствовать в запросе или передаваться с пустым значением.
Обязательный параметр