modify

Включить или редактировать характеристику пользовательского таргетинга. В ADFOX доступно 63 характеристики, по которым можно настроить справочники со значениями для таргетирования рекламных кампаний.

Дополнительное таргетирование — это вид таргетирования, где клиент ADFOX самостоятельно определяет характеристики для выбора целевой аудитории. Каждая характеристика содержит набор значений, которые представляют собой знания сайта о загруженной странице сайта или о его посетителе. Передача значений для таргетирования осуществляется со стороны сайта через код вставки.

Данный запрос позволяет выполнить два действия:

  1. включить новую характеристику для пользовательского таргетирования — в этом случае параметры criteriaName, criteriaTargetingName, criteriaReportName обязательны;
  2. отредактировать ранее включенную характеристику — параметры criteriaName, criteriaTargetingName, criteriaReportName являются необязательными.
  1. Формат запроса
  2. Формат ответа
  3. Параметры ответа
  4. Другие действия с объектом

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

https://api.adfox.ru/v1/API.php
 ? loginAccount=<string>
 & loginPassword=<string>
 & object=userCriteria
 & action=modify
 & criteriaID=<integer>
 & [isOn=<integer>]
 & criteriaName=<string>
 & criteriaTargetingName=<string>
 & criteriaReportName=<string>
Query-параметры
criteriaID *

ID пользовательской характеристики.

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

  • 1≤N≤63, где N — порядковый номер характеристики от 1 до 63 включительно.
isOn

Включить/выключить объект.

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

  • 0 — выключен;
  • 1 — включен.

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

criteriaName *

Название пользовательской характеристики.

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

Если производится включение новой характеристики, то параметр становится обязательным.

criteriaTargetingName *

Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера.

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

Если производится включение новой характеристики, то параметр становится обязательным.

criteriaReportName *

Название отчета по таргетированию по пользовательской характеристике.

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

Если производится включение новой характеристики, то параметр становится обязательным.

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

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

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

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

code

Статус обработки запроса. Расшифровку смотрите в разделе Обработка ошибок.

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

Запрос:

https://api.adfox.ru/v1/API.php?loginAccount={your_login}&loginPassword={sha256_your_password}&object=userCriteria&action=modify&criteriaID=8&criteriaName=weather

Ответ:

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

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

См. также другие действия с объектом userCriteria: