addValue

Добавить значение для характеристики пользовательского таргетинга.

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

https://adfox.yandex.ru/api/v1
  ? object=userCriteria
  & action=addValue
  & criteriaID=<integer>
  & userID=<string>
  & name=<string>
  & [isOn=<integer>]

criteriaID*

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

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

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

userID*

Идентификатор, который передается в код вставки.

name*

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

isOn

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

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

  • 0 — не таргетировать на новое значение. В уже существующие рекламные кампании и баннеры новое значение характеристики будет добавлено ** включенным**, вне зависимости от заданных ранее настроек таргетирования;
  • 1 — таргетировать на новое значение. В уже существующие рекламные кампании и баннеры новое значение характеристики будет добавлено:
    • включенным — если в таргетировании этой характеристики все ранее добавленные значения включены (объект не страгетирован);
    • выключенным — если в таргетировании этой характеристики есть хоть одно выключенное значение (объект был старгетирован).

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

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

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

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

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

code

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

ID

Идентификатор объекта.

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

Запрос:

https://adfox.yandex.ru/api/v1?object=userCriteria&action=addValue&criteriaID=1&userID=man&name=man&isOn=0

Ответ:

<response>
  <status>
    <code>0</code>
    <ID>39377</ID>
  </status>
</response>

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

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

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

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

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

Идентификатор, который передается в код вставки.

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

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

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

  • 0 — не таргетировать на новое значение. В уже существующие рекламные кампании и баннеры новое значение характеристики будет добавлено ** включенным**, вне зависимости от заданных ранее настроек таргетирования;

  • 1 — таргетировать на новое значение. В уже существующие рекламные кампании и баннеры новое значение характеристики будет добавлено:

    • включенным — если в таргетировании этой характеристики все ранее добавленные значения включены (объект не страгетирован);
    • выключенным — если в таргетировании этой характеристики есть хоть одно выключенное значение (объект был старгетирован).

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

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

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