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 | Массив, содержащий логины клиентов, для которых нужно выполнить операцию. Для прямых рекламодателей параметр игнорируется. | Нет |
Примечания | ||
Внимание.
|
Параметр | Описание | Требуется |
Объект RetargetingConditionRequest | ||
---|---|---|
Action | Выполняемая операция: Get. | Да |
SelectionCriteria | Объект SelectionCriteria, содержащий критерии отбора условий ретаргетинга. | Да |
Объект RetargetingConditionSelectionCriteria | ||
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, может использовать только цели Яндекс Метрики. |
Goals | Массив целей и сегментов — объектов RetargetingConditionGoalItem. |
Объект RetargetingConditionGoalItem | |
Time | Количество дней (от 1 до 90), за которое проверяется выполнение цели или попадание в сегмент. |
GoalID | Идентификатор цели или сегмента. |
Параметр | Описание |
Объект RetargetingConditionResponse | |
---|---|
RetargetingConditions | Метод возвращает массив объектов RetargetingCondition, каждый из которых содержит сведения об условии ретаргетинга. |
Объект RetargetingCondition | |
IsAccessible | Yes — все цели и сегменты в условии ретаргетинга доступны; No — в условии есть недоступная цель или сегмент, показ объявлений по данному условию невозможен. Цель или сегмент становятся недоступными в случае удаления или в случае, если доступ отменен владельцем (см. раздел Управление доступом к счетчикам помощи Яндекс Метрики). |
RetargetingConditionName | Наименование условия ретаргетинга (не более 250 символов). |
RetargetingConditionDescription | Текстовое примечание к условию ретаргетинга (не более 4096 символов). |
Login | Логин владельца условия. |
RetargetingConditionID | Идентификатор условия ретаргетинга. |
RetargetingCondition | Массив объектов RetargetingConditionItem. Каждый объект содержит группу, описывающую желаемое поведение пользователей. Если в условии ретаргетинга несколько групп, то они объединены логическим оператором И (условие выполнено, если выполнены все группы). |
Объект RetargetingConditionItem | |
Type | Тип группы:
Условие ретаргетинга, использующее сегменты Яндекс Метрики или сегменты Яндекс Аудиторий, должно содержать по крайней мере одну группу с типом 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']
}
}