targetingURL

Таргетировать баннер по URL.

Этот вид таргетирования будет удобен, если показ рекламы необходимо произвести по определенному списку страниц сайта или же запретить показ на отдельных страницах.

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

https://adfox.yandex.ru/api/v1
  ? object=banner
  & action=target
  & actionObject=targetingURL
  & objectID=<integer>
  & isRedefined=<integer>
  & [templateType=<integer>]
  & [targetingUrlOn[]=<string>]
  & [targetingUrlOff[]=<string>]

objectID*

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

isRedefined*

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

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

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

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

templateType

Тип шаблона для таргетирования по URL.

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

  • 0 — стандартный. В шаблоне URL используйте символ * для обозначения последовательности любых символов любой длины.
  • 1 — POSIX. В шаблоне URL используйте регулярные выражения по стандарту POSIX.

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

targetingUrlOn[]

URL страницы, на которой разрешен показ.

Если URL несколько, то каждый URL надо передавать в отдельном параметре. Максимальное количество параметров с URL — 5.

Пример записи:

targetingUrlOn[]=url1&targetingUrlOn[]=url2...

targetingUrlOff[]

URL страницы, на которой запрещен показ.

Если URL несколько, то каждый URL надо передавать в отдельном параметре. Максимальное количество параметров с URL — 5.

Пример записи:

targetingUrlOff[]=url1&targetingUrlOff[]=url2...

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

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

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

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

code

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

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

Запрос:

https://adfox.yandex.ru/api/v1?object=banner&action=target&actionObject=targetingURL&objectID=474205&isRedefined=1&templateType=0&targetingUrlOn[]=*site.ru/&targetingUrlOn[]=*site.ru/*&targetingUrlOff[]=https://www.demo.site.ru/*

Ответ:

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

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

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

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