Get

Возвращает условия ретаргетинга.

Внимание.

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

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

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

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

{
   "method": "RetargetingCondition",
   "param": {
      /* RetargetingConditionRequest */
      "Action": (string),
      "SelectionCriteria": {
         /* RetargetingConditionSelectionCriteria */
         "RetargetingConditionIDS": [
            (int)
            ...
         ],
         "Logins": [
            (string)
            ...
         ]
      }
   }
}

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

ПараметрОписаниеТребуется
Объект RetargetingConditionRequest
ActionВыполняемая операция: Get.Да
SelectionCriteriaОбъект SelectionCriteria, содержащий критерии отбора условий ретаргетинга.Да
Объект RetargetingConditionSelectionCriteria
RetargetingConditionIDSМассив, содержащий идентификаторы условий ретаргетинга, для которых нужно выполнить операцию.Нет
Logins

Массив, содержащий логины клиентов, для которых нужно выполнить операцию.

Для прямых рекламодателей параметр игнорируется.

Нет
Примечания
Внимание.
  1. Для рекламодателей в случае пустой структуры SelectionCriteria операция будет выполнена для всех условий ретаргетинга.
  2. Для агентств должен быть задан хотя бы один из параметров RetargetingConditionIDS и Logins. Если заданы оба параметра, операция будет выполнена для условий ретаргетинга, отвечающих одновременно обоим критериям: идентификатор условия указан в массиве RetargetingConditionIDS и логин владельца условия указан в массиве Logins.

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

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

{
   "data": {
      /* RetargetingConditionResponse */
      "RetargetingConditions": [
         {  /* RetargetingCondition */
            "IsAccessible": (string),
            "RetargetingConditionName": (string),
            "RetargetingConditionDescription": (string),
            "Login": (string),
            "RetargetingConditionID": (int),
            "RetargetingCondition": [
               {  /* RetargetingConditionItem */
                  "Type": (string),
                  "Goals": [
                     {  /* RetargetingConditionGoalItem */
                        "Time": (int),
                        "GoalID": (long)
                     }
                     ...
                  ] 
               } 
               ...
            ]
         }
         ...
      ]
   }
}

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

ПараметрОписание
Объект RetargetingConditionResponse
RetargetingConditionsМетод возвращает массив объектов RetargetingCondition, каждый из которых содержит сведения об условии ретаргетинга.
Объект RetargetingCondition
IsAccessible

Yes — все цели и сегменты в условии ретаргетинга доступны; No — в условии есть недоступная цель или сегмент, показ объявлений по данному условию невозможен.

Цель или сегмент становятся недоступными в случае удаления или в случае, если доступ отменен владельцем (см. раздел Управление доступом к счетчикам помощи Яндекс.Метрики).

RetargetingConditionNameНаименование условия ретаргетинга (не более 250 символов).
RetargetingConditionDescriptionТекстовое примечание к условию ретаргетинга (не более 4096 символов).
LoginЛогин владельца условия.
RetargetingConditionIDИдентификатор условия ретаргетинга.
RetargetingConditionМассив объектов RetargetingConditionItem. Каждый объект содержит группу, описывающую желаемое поведение пользователей. Если в условии ретаргетинга несколько групп, то они объединены логическим оператором И (условие выполнено, если выполнены все группы).
Объект RetargetingConditionItem
Type

Тип группы:

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

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

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

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

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

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

Python

{
   'Action': 'Get',
   'SelectionCriteria': {
      'Logins': ['agrom','larry']
   }
}

PHP

array(
   'Action' => 'Get',
   'SelectionCriteria' => array(
      'Logins' => array('agrom','larry')
   )
)

Perl

{
   'Action' => 'Get',
   'SelectionCriteria' => {
      'Logins' => ['agrom','larry']
   }
}