modify

Редактировать параметры площадки.

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

https://adfox.yandex.ru/api/v1
  ? object=place
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [categoryID=<integer>]
  & [positionID=<integer>]
  & [pct=<integer>]
  & [plp=<integer>]
  & [pli=<integer>]
  & [pop=<integer>]

objectID*

ID объекта, над которым производится действие.

name

Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.

categoryID

ID категории.

Читайте также:

positionID

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

Читайте также:

pct

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

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

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

plp

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

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

  • -1 — из URL запроса (по умолчанию) — настройки ограничения показов будут использоваться из параметров URL запроса за баннером. Если в запросе значения не были переданы, то считается, что площадка без ограничений. Параметрыpli (количество показов за период) и pop (другой период) должны быть пустыми или отсутствовать в запросе;
  • 0 — без ограничений — показы баннеров на данной площадке не ограничиваются, даже если в параметрах запроса указано иное. Параметры pli (количество показов за период) и pop (другой период) должны быть пустыми или отсутствовать в запросе;
  • 1 — один час — ограничение действует один час с момента первого показа баннера уникальному пользователю;
  • 2 — шесть часов — ограничение действует шесть часов с момента первого показа баннера уникальному пользователю;
  • 3 — 12 часов — ограничение действует 12 часов с момента первого показа баннера уникальному пользователю.
  • 4 — 24 часа — ограничение действует 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>
</status>
</response>

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

code

Статус обработки запроса. Значение 0 — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=place&action=modify&objectID=543&name=site.ru/news/240

Ответ:

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

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

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

Предыдущая
Следующая