targetingGeobase

Таргетировать размещение кампании на площадке по географии.

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

https://adfox.yandex.ru/api/v1
  ? object=campaign
  & action=targetPlace
  & actionObject=targetingGeobase
  & objectID=<integer>
  & placeID=<integer>
  & isRedefined=<integer>
  & geo=<integer>
  & [global=<integer>]
  & [regions=<string>]

objectID*

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

placeID*

ID площадки.

isRedefined*

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

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

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

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

geo*

Включить таргетирование по географии.

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

  • 0 — выключить;
  • 1 — включить.

global

Настройка для пункта «Весь мир», с помощью которой можно указать логику таргетирования:

  • «все разрешено, кроме» — если объектов для выключения меньше, то включите «Весь мир» и выключите определенные объекты в списке;

  • «все запрещено, кроме» — если требуется включить показы только на определенные объекты, выключите «Весь мир» и включите нужные объекты в списке.

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

  • 0 — сброшено — наследуется от элемента-родителя;
  • 1 — разрешено;
  • 2 — запрещено.

regions

Укажите статус таргетирования для регионов.

Формат записи: {"225":2,"3":0}, где: {"ID региона":значение,"ID региона":значение}.

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

  • 0 — сброшено — наследуется от элемента-родителя;
  • 1 — разрешено;
  • 2 — запрещено.

Например, запись regions={"225":1} разрешает показы в России.

Настройку для пункта «Весь мир» можно также задать и через параметр regions с ID=10000. Эта настройка будет приоритетнее, чем значение, переданное в параметре global.

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

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

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

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

code

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

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

Запрос:

https://adfox.yandex.ru/api/v1?object=campaign&action=targetPlace&actionObject=targetingGeobase&objectID=474205&placeID=321&isRedefined=1

Ответ:

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

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

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

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