add

Создает условия ретаргетинга и подбора аудитории.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Одному рекламодателю может принадлежать не более 2000 условий ретаргетинга и подбора аудитории.

Не более 1000 условий ретаргетинга и подбора аудитории в одном вызове метода.

Запрос

Структура запроса в формате JSON:

{
  "method": "add",
  "params": { /* params */
    "RetargetingLists": [{  /* RetargetingListAddItem */
      "Type": ( RETARGETING | AUDIENCE ),
      "Name": (string), /* required */
      "Description": (string),
      "Rules": [{  /* RetargetingListRuleItem */
        "Arguments": [{  /* RetargetingListRuleArgumentItem */
           "MembershipLifeSpan": (int),
           "ExternalId": (long) /* required */
        }, ... ], /* required */
        "Operator": ( "ALL" | "ANY" | "NONE" ) /* required */
      }, ... ] /* required */
    }, ... ]
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
RetargetingLists array of RetargetingListAddItem Условия ретаргетинга и подбора аудитории, которые требуется добавить. Да
Структура RetargetingListAddItem
Type RetargetingListTypeEnum

Тип условия ретаргетинга и подбора аудитории. См. раздел Тип условия ретаргетинга и подбора аудитории.

Значение по умолчанию — RETARGETING.

Нет
Name string Название условия ретаргетинга и подбора аудитории (не более 250 символов). Да
Description string Текстовое примечание к условию ретаргетинга и подбора аудитории (не более 4096 символов). Нет
Rules array of RetargetingListRuleItem Правила отбора посетителей сайта. Посетитель удовлетворяет условию ретаргетинга и подбора аудитории, если для него выполнены одновременно все правила.

Ограничения на правила отбора и примеры структуры приведены в разделе Правила отбора пользователей.

Да
Структура RetargetingListRuleItem
Arguments array of RetargetingListRuleArgumentItem

Цели и сегменты.

См. раздел Цели и сегменты.

Да
Operator RetargetingListRuleOperatorEnum

Логический оператор правила отбора:

  • ALL — правило выполнено, если пользователь выполнил все цели и входит во все сегменты;

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

  • NONE — правило выполнено, если пользователь не выполнил ни одну из целей и не входит ни в один из сегментов.

Да
Структура RetargetingListRuleArgumentItem
MembershipLifeSpan int

Количество дней (от 1 до 540), за которое проверяется выполнение цели.

Для сегментов Яндекс.Метрики и сегментов Яндекс.Аудиторий параметр не используется, переданное значение игнорируется.

Для целей Яндекс.Метрики
ExternalId long

Идентификатор цели или сегмента.

Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ... ] 
    }, ... ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления условий ретаргетинга и подбора аудитории.
Структура ActionResult
Id long Идентификатор созданного условия ретаргетинга и подбора аудитории. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.

Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.