targetingGeobase
Таргетировать размещение кампании на сайте по географии.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=campaign
& action=targetWebsite
& actionObject=targetingGeobase
& objectID=<integer>
& siteID=<integer>
& isRedefined=<integer>
& geo=<integer>
& [global=<integer>]
& [regions=<string>]
|
ID объекта, над которым производится действие. |
|
ID сайта. |
|
Переопределить таргетирование. Возможные значения:
|
|
Включить таргетирование по географии. Допустимые значения:
|
|
Настройка для пункта «Весь мир», с помощью которой можно указать логику таргетирования:
Допустимые значения:
|
|
Укажите статус таргетирования для регионов. Формат записи: Допустимые значения:
Например, запись Настройку для пункта «Весь мир» можно также задать и через параметр regions с ID=10000. Эта настройка будет приоритетнее, чем значение, переданное в параметре global. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=campaign&action=targetWebsite&actionObject=targetingGeobase&objectID=474205&siteID=321&isRedefined=1
Ответ:
<response> <status> <code>0</code> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом campaign
:
- добавить кампанию
- получить список кампаний;
- удалить кампанию;
- редактировать кампанию;
- получить список баннеров рекламной кампании;
- разместить кампанию на сайте, разделе, площадке.
ID объекта, над которым производится действие.
ID сайта.
Переопределить таргетирование.
Возможные значения:
-
0
— наследовать настройки таргетирования, установленные на уровне выше. Иерархия уровней от верхнего к нижнему:-
кампания;
-
размещение кампании на сайте;
-
размещение кампании на разделе сайта;
-
размещение кампании на площадке;
-
баннер.
-
-
1
— отменить настройки таргетирования на более высоких уровнях и использовать настройки, установленные на текущем уровне.
Включить таргетирование по географии.
Допустимые значения:
-
0
— выключить; -
1
— включить.
Настройка для пункта «Весь мир», с помощью которой можно указать логику таргетирования:
-
«все разрешено, кроме» — если объектов для выключения меньше, то включите «Весь мир» и выключите определенные объекты в списке;
-
«все запрещено, кроме» — если требуется включить показы только на определенные объекты, выключите «Весь мир» и включите нужные объекты в списке.
Допустимые значения:
-
0
— сброшено — наследуется от элемента-родителя; -
1
— разрешено; -
2
— запрещено.
Укажите статус таргетирования для регионов.
Формат записи: {"225":2,"3":0}
, где: {"ID региона":значение,"ID региона":значение}
.
Допустимые значения:
-
0
— сброшено — наследуется от элемента-родителя; -
1
— разрешено; -
2
— запрещено.
Например, запись regions={"225":1}
разрешает показы в России.
Настройку для пункта «Весь мир» можно также задать и через параметр regions с ID=10000. Эта настройка будет приоритетнее, чем значение, переданное в параметре global.
Обязательный параметр