modify
Включить или редактировать характеристику пользовательского таргетинга. В Adfox доступно 63 характеристики, по которым можно настроить справочники со значениями для таргетирования рекламных кампаний.
Дополнительное таргетирование — это вид таргетирования, где клиент Adfox самостоятельно определяет характеристики для выбора целевой аудитории. Каждая характеристика содержит набор значений, которые представляют собой знания сайта о загруженной странице сайта или о его посетителе. Передача значений для таргетирования осуществляется со стороны сайта через код вставки.
Данный запрос позволяет выполнить два действия:
- включить новую характеристику для пользовательского таргетирования — в этом случае параметры criteriaName, criteriaTargetingName, criteriaReportName обязательны;
- отредактировать ранее включенную характеристику — параметры criteriaName, criteriaTargetingName, criteriaReportName являются необязательными.
Формат запроса
https://adfox.yandex.ru/api/v1
? object=userCriteria
& action=modify
& criteriaID=<integer>
& [isOn=<integer>]
& criteriaName=<string>
& criteriaTargetingName=<string>
& criteriaReportName=<string>
|
ID пользовательской характеристики. Допустимые значения:
|
|
Включить/выключить объект. Допустимые значения:
Значение по умолчанию: |
|
Название пользовательской характеристики. Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. |
|
Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера. Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. |
|
Название отчета по таргетированию по пользовательской характеристике. Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=userCriteria&action=modify&criteriaID=8&criteriaName=weather
Ответ:
<response> <status> <code>0</code> </status> </response>
Другие действия с объектом
Читайте также о других действиях с объектом userCriteria
:
- добавить значение характеристики.
- получить список значений характеристики;
- редактировать значение характеристики;
- удалить значение характеристики;
ID пользовательской характеристики.
Допустимые значения:
1≤N≤63
, где N — порядковый номер характеристики от 1 до 63 включительно.
Включить/выключить объект.
Допустимые значения:
-
0
— выключен; -
1
— включен.
Значение по умолчанию: 1
.
Название пользовательской характеристики.
Может содержать русские и латинские буквы, цифры и любые символы.
Если производится включение новой характеристики, то параметр становится обязательным.
Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера.
Может содержать русские и латинские буквы, цифры и любые символы.
Если производится включение новой характеристики, то параметр становится обязательным.
Название отчета по таргетированию по пользовательской характеристике.
Может содержать русские и латинские буквы, цифры и любые символы.
Если производится включение новой характеристики, то параметр становится обязательным.
Обязательный параметр