update

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

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

Ограничения

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

  • Если условие ретаргетинга и подбора аудитории содержит хотя бы одно правило с оператором ALL или ANY, то и после редактирования оно должно содержать хотя бы одно правило с оператором ALL или ANY.
  • Если условие ретаргетинга и подбора аудитории состоит только из правил с оператором NONE, то и после редактирования оно должно состоять только из правил с оператором NONE.
  • Если условие ретаргетинга и подбора аудитории с типом AUDIENCE содержит только краткосрочные интересы и используется для нацеливания на аудиторию в группе текстово-графических объявлений, то и после редактирования оно должно содержать только краткосрочные интересы.

Запрос

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

{
  "method": "update",
  "params": { /* params */
    "RetargetingLists": [{  /* RetargetingListUpdateItem */
      "Id": (long), /* required */
      "Name": (string),
      "Description": (string),
      "Rules": [{  /* RetargetingListRuleItem */
        "Arguments": [{  /* RetargetingListRuleArgumentItem */
          "MembershipLifeSpan": (int),
          "ExternalId": (long) /* required */
        }, ... ], /* required */
        "Operator": ( "ALL" | "ANY" | "NONE" ) /* required */
      }, ... ]
    }, ... ] /* required */
 }
} 
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / UpdateRequest (для SOAP)
RetargetingLists array of RetargetingListUpdateItem Условия ретаргетинга и подбора аудитории, которые требуется изменить. Да
Структура RetargetingListUpdateItem
Id long Идентификатор условия ретаргетинга и подбора аудитории. Да
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

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

Для сегментов по интересам пользователя необходимо перед идентификатором указать тип интереса с помощью префикса:

  • 10 — краткосрочный интерес;
  • 20 — долгосрочный интерес;
  • 30 — любой интерес.

Например, идентификатору сегмента 2499001105 при долгосрочном интересе будет соответствовать ExternalId 202499001105.

Да
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / UpdateRequest (для SOAP)
RetargetingLists array of RetargetingListUpdateItem Условия ретаргетинга и подбора аудитории, которые требуется изменить. Да
Структура RetargetingListUpdateItem
Id long Идентификатор условия ретаргетинга и подбора аудитории. Да
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

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

Для сегментов по интересам пользователя необходимо перед идентификатором указать тип интереса с помощью префикса:

  • 10 — краткосрочный интерес;
  • 20 — долгосрочный интерес;
  • 30 — любой интерес.

Например, идентификатору сегмента 2499001105 при долгосрочном интересе будет соответствовать ExternalId 202499001105.

Да

Ответ

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

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

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

Errors array of ExceptionNotification

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

Параметр Тип Описание
Структура result (для JSON) / UpdateResponse (для SOAP)
UpdateResults array of ActionResult Результаты изменения параметров условий ретаргетинга и подбора аудитории.
Структура ActionResult
Id long Идентификатор условия ретаргетинга и подбора аудитории. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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