Update

Изменяет условия ретаргетинга.

Внимание.

Метод устарел и скоро будет отключен. Используйте API версии 5.

Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.

Ограничения

Если условие ретаргетинга содержит хотя бы одну группу с типом all или or, то после редактирования оно также должно содержать хотя бы одну группу с типом all или or.

Если условие ретаргетинга содержит только группы с типом not, то после редактирования оно также должно содержать только группы с типом not.

Входные данные

Ниже показана структура входных данных в формате JSON.

{
   "method": "RetargetingCondition",
   "param": {
      /* RetargetingConditionRequest */
      "Action": (string),
      "RetargetingConditions": [
         {  /* RetargetingCondition */
            "Fields": [
               (string)
               ...
            ],
            "RetargetingConditionName": (string),
            "RetargetingConditionDescription": (string),
            "RetargetingConditionID": (int),
            "RetargetingCondition": [
               {  /* RetargetingConditionItem */
                  "Type": (string),
                  "Goals": [
                     {  /* RetargetingConditionGoalItem */
                        "Time": (int),
                        "GoalID": (long)
                     }
                     ...
                  ] 
               } 
               ...
            ]
         }
         ...
      ]
   }
}

Ниже приведено описание параметров.

Параметр Описание Требуется
Объект RetargetingConditionRequest
Action Выполняемая операция: Update. Да
RetargetingConditions Массив объектов RetargetingCondition, содержащих информацию об условиях ретаргетинга. Да
Объект RetargetingCondition
Fields Названия параметров, которые необходимо обновить. Если не задано, будут обновлены (а если значение не задано — сброшены) все параметры. Нет
RetargetingConditionName Наименование условия ретаргетинга (не более 250 символов). Нет
RetargetingConditionDescription Текстовое примечание к условию ретаргетинга (не более 4096 символов). Нет
RetargetingConditionID

Идентификатор условия ретаргетинга.

Да
RetargetingCondition Массив объектов RetargetingConditionItem. Каждый объект содержит группу, описывающую желаемое поведение пользователей. Если в условии ретаргетинга несколько групп, то они объединены логическим оператором И (условие выполнено, если выполнены все группы). Да
Объект RetargetingConditionItem
Type

Тип группы:

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

Условие ретаргетинга, использующее сегменты Яндекс.Метрики или сегменты Яндекс.Аудиторий, должно содержать по крайней мере одну группу с типом all или or. Условие ретаргетинга, состоящее только из групп с типом not, может использовать только цели Яндекс.Метрики.

Да
Goals Массив целей и сегментов — объектов RetargetingConditionGoalItem. Да
Объект RetargetingConditionGoalItem
Time

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

Для целей и сегментов Яндекс.Метрики
GoalID Идентификатор цели или сегмента. Да

Результирующие данные

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

Ниже показана структура результирующих данных в формате JSON.

{
   "data": {
      /* RetargetingConditionResponse */
      "ActionsResult": [
         {  /* RetargetingConditionActionResult */
            "Warnings": [
               {  /* Warning */
                  "WarningCode": (int),
                  "WarningString": (string),
                  "Description": (string)
               }
               ...
            ],
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ],
            "RetargetingConditionID": (int)
         }
         ...
      ]
   }
}

Ниже приведено описание параметров.

Параметр Описание
Объект RetargetingConditionResponse
ActionsResult

Массив объектов RetargetingConditionActionResult. Каждый объект соответствует элементу входного массива RetargetingConditions и содержит:

  • в случае успешного выполнения операции — идентификатор добавленного/измененного условия ретаргетинга;
  • если операция была выполнена, однако при ее выполнении возникли особенности — идентификатор добавленного/измененного условия ретаргетинга и массив Warnings, содержащий описание особенностей;
  • в случае ошибки — массив Errors.

Элементы массива следуют в том же порядке, что и объекты входного массива RetargetingConditions.

Объект RetargetingConditionActionResult
Warnings Массив объектов Warning — предупреждений, возникших при выполнении операции.
Errors Массив объектов Error — ошибок, возникших при выполнении операции.
RetargetingConditionID Идентификатор условия ретаргетинга.
Объект Warning
WarningCode Код предупреждения.
WarningString Текст предупреждения.
Description Описание предупреждения в формате JSON.
Объект Error
FaultCode Код ошибки.
FaultString Текст сообщения об ошибке.
FaultDetail Подробное описание причины ошибки.

Примеры входных данных

Python

{
   'Action': 'Update',
   'RetargetingConditions': [
      {
         'Fields': ['RetargetingCondition'],
         'RetargetingConditionID': 123789,
         'RetargetingCondition': [
            {
               'Type': 'or',
               'Goals': [
                  {  
                     'Time': 14,
                     'GoalID': 1557799
                  },
                  {  
                     'Time': 14,
                     'GoalID': 1558005
                  }
               ]
            }
         ]
      }
   ]
}

PHP

array(
   'Action' => 'Update',
   'RetargetingConditions' => array(
      array(
         'Fields' => array('RetargetingCondition'),
         'RetargetingConditionID' => 123789,
         'RetargetingCondition' => array(
            array(
               'Type' => 'or',
               'Goals' => array(
                  array(
                     'Time' => 14,
                     'GoalID' => 1557799
                  ),
                  array(
                     'Time' => 14,
                     'GoalID' => 1558005
                  )
               )
            )
         )
      )
   )
)

Perl

{
   'Action' => 'Update',
   'RetargetingConditions' => [
      {
         'Fields' => ['RetargetingCondition'],
         'RetargetingConditionID' => 123789,
         'RetargetingCondition' => [
            {
               'Type' => 'or',
               'Goals' => [
                  {  
                     'Time' => 14,
                     'GoalID' => 1557799
                  },
                  {  
                     'Time' => 14,
                     'GoalID' => 1558005
                  }
               ]
            }
         ]
      }
   ]
}