GetRetargetingGoals (Live)

Возвращает идентификаторы доступных целей и сегментов.

Прямой рекламодатель может получать цели и сегменты, доступные его представителям.

Рекламное агентство может получать цели и сегменты, доступные его клиентам.

Новое в версии Live 4

Добавлен результирующий параметр Type.

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

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

{
   "method": "GetRetargetingGoals",
   "param": {
      /* GetRetargetingGoalsRequest */
      "Logins": [
         (string)
         ...
      ]
   }
}
Параметр Описание Требуется
Объект GetRetargetingGoalsRequest
Logins

Параметр используется только при выполнении запроса от лица рекламного агентства. В параметре задают массив логинов клиентов (не более 100), для которых требуется получить цели и сегменты. Если параметр не задан, возвращается сообщение об ошибке 71. При указании несуществующего логина или логина, не принадлежащего клиенту агентства, возвращается сообщение об ошибке 54.

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

 Для рекламных агентств
Параметр Описание Требуется
Объект GetRetargetingGoalsRequest
Logins

Параметр используется только при выполнении запроса от лица рекламного агентства. В параметре задают массив логинов клиентов (не более 100), для которых требуется получить цели и сегменты. Если параметр не задан, возвращается сообщение об ошибке 71. При указании несуществующего логина или логина, не принадлежащего клиенту агентства, возвращается сообщение об ошибке 54.

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

 Для рекламных агентств

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

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

{
   "data": [
      {  /* RetargetingGoal */
         "GoalID": (long),
         "Name": (string),
         "GoalDomain": (string),
         "Type": (string),
         "Login": (string)
      }
      ...
   ]
}

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

Параметр Описание
Объект RetargetingGoal
GoalID Идентификатор цели или сегмента.
Name Наименование цели или сегмента.
GoalDomain Домен, на котором установлен счетчик Яндекс Метрики.
Type

Тип объекта:

  • goal — цель Яндекс Метрики;
  • segment — сегмент Яндекс Метрики;
  • audience_segment — сегмент Яндекс Аудиторий.
Login Логин клиента, которому принадлежит цель или сегмент.
Параметр Описание
Объект RetargetingGoal
GoalID Идентификатор цели или сегмента.
Name Наименование цели или сегмента.
GoalDomain Домен, на котором установлен счетчик Яндекс Метрики.
Type

Тип объекта:

  • goal — цель Яндекс Метрики;
  • segment — сегмент Яндекс Метрики;
  • audience_segment — сегмент Яндекс Аудиторий.
Login Логин клиента, которому принадлежит цель или сегмент.

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

Python

{
   'Logins': ['agrom','larry']
}

PHP

array(
   'Logins' => array('agrom','larry')
)

Perl

{
   'Logins' => ['agrom','larry']
}