Add
Создает условия ретаргетинга.
Метод отключен. Используйте API версии 5.
Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "RetargetingCondition",
"param": {
/* RetargetingConditionRequest */
"Action": (string),
"RetargetingConditions": [
{ /* RetargetingCondition */
"RetargetingConditionName": (string),
"RetargetingConditionDescription": (string),
"Login": (string),
"RetargetingCondition": [
{ /* RetargetingConditionItem */
"Type": (string),
"Goals": [
{ /* RetargetingConditionGoalItem */
"Time": (int),
"GoalID": (long)
}
...
]
}
...
]
}
...
]
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект RetargetingConditionRequest | ||
---|---|---|
Action | Выполняемая операция: Add. | Да |
RetargetingConditions | Массив объектов RetargetingCondition, содержащих информацию об условиях ретаргетинга. | Да |
Объект RetargetingCondition | ||
RetargetingConditionName | Наименование условия ретаргетинга (не более 250 символов). | Да |
RetargetingConditionDescription | Текстовое примечание к условию ретаргетинга (не более 4096 символов). | Нет |
Login | Логин владельца условия. Прямые рекламодатели указывают собственный логин, рекламные агентства — логин своего клиента. | Да |
RetargetingCondition | Массив объектов RetargetingConditionItem. Каждый объект содержит группу, описывающую желаемое поведение пользователей. Если в условии ретаргетинга несколько групп, то они объединены логическим оператором И (условие выполнено, если выполнены все группы). | Да |
Объект RetargetingConditionItem | ||
Type | Тип группы:
Условие ретаргетинга, использующее сегменты Яндекс Метрики или сегменты Яндекс Аудиторий, должно содержать по крайней мере одну группу с типом all или or. Условие ретаргетинга, состоящее только из групп с типом not, может использовать только цели Яндекс Метрики. | Да |
Goals | Массив целей и сегментов — объектов RetargetingConditionGoalItem. | Да |
Объект RetargetingConditionGoalItem | ||
Time | Количество дней (от 1 до 90), за которое проверяется выполнение цели или попадание в сегмент. | Для целей и сегментов Яндекс Метрики |
GoalID | Идентификатор цели или сегмента. | Да |
Параметр | Описание | Требуется |
Объект RetargetingConditionRequest | ||
---|---|---|
Action | Выполняемая операция: Add. | Да |
RetargetingConditions | Массив объектов RetargetingCondition, содержащих информацию об условиях ретаргетинга. | Да |
Объект RetargetingCondition | ||
RetargetingConditionName | Наименование условия ретаргетинга (не более 250 символов). | Да |
RetargetingConditionDescription | Текстовое примечание к условию ретаргетинга (не более 4096 символов). | Нет |
Login | Логин владельца условия. Прямые рекламодатели указывают собственный логин, рекламные агентства — логин своего клиента. | Да |
RetargetingCondition | Массив объектов RetargetingConditionItem. Каждый объект содержит группу, описывающую желаемое поведение пользователей. Если в условии ретаргетинга несколько групп, то они объединены логическим оператором И (условие выполнено, если выполнены все группы). | Да |
Объект RetargetingConditionItem | ||
Type | Тип группы:
Условие ретаргетинга, использующее сегменты Яндекс Метрики или сегменты Яндекс Аудиторий, должно содержать по крайней мере одну группу с типом 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 и содержит:
Элементы массива следуют в том же порядке, что и объекты входного массива RetargetingConditions. |
Объект RetargetingConditionActionResult | |
Warnings | Массив объектов Warning — предупреждений, возникших при выполнении операции. |
Errors | Массив объектов Error — ошибок, возникших при выполнении операции. |
RetargetingConditionID | Идентификатор условия ретаргетинга. |
Объект Warning | |
WarningCode | Код предупреждения. |
WarningString | Текст предупреждения. |
Description | Описание предупреждения в формате JSON. |
Объект Error | |
FaultCode | Код ошибки. |
FaultString | Текст сообщения об ошибке. |
FaultDetail | Подробное описание причины ошибки. |
Параметр | Описание |
Объект RetargetingConditionResponse | |
---|---|
ActionsResult | Массив объектов RetargetingConditionActionResult. Каждый объект соответствует элементу входного массива RetargetingConditions и содержит:
Элементы массива следуют в том же порядке, что и объекты входного массива RetargetingConditions. |
Объект RetargetingConditionActionResult | |
Warnings | Массив объектов Warning — предупреждений, возникших при выполнении операции. |
Errors | Массив объектов Error — ошибок, возникших при выполнении операции. |
RetargetingConditionID | Идентификатор условия ретаргетинга. |
Объект Warning | |
WarningCode | Код предупреждения. |
WarningString | Текст предупреждения. |
Description | Описание предупреждения в формате JSON. |
Объект Error | |
FaultCode | Код ошибки. |
FaultString | Текст сообщения об ошибке. |
FaultDetail | Подробное описание причины ошибки. |
Примеры входных данных
Python
{
'Action': 'Add',
'RetargetingConditions': [
{
'RetargetingConditionName': u'Незавершенный заказ',
'RetargetingConditionDescription': u'Положил товар в корзину, но заказ не оформил',
'Login': 'agrom',
'RetargetingCondition': [
{
'Type': 'or',
'Goals': [
{
'Time': 14,
'GoalID': 1557799
},
{
'Time': 14,
'GoalID': 1558005
}
]
},
{
'Type': 'not',
'Goals': [
{
'Time': 11,
'GoalID': 1559911
}
]
}
]
}
]
}
PHP
array(
'Action' => 'Add',
'RetargetingConditions' => array(
array(
'RetargetingConditionName' => 'Незавершенный заказ',
'RetargetingConditionDescription' => 'Положил товар в корзину, но заказ не оформил',
'Login' => 'agrom',
'RetargetingCondition' => array(
array(
'Type' => 'or',
'Goals' => array(
array(
'Time' => 14,
'GoalID' => 1557799
),
array(
'Time' => 14,
'GoalID' => 1558005
)
)
),
array(
'Type' => 'not',
'Goals' => array(
array(
'Time' => 11,
'GoalID' => 1559911
)
)
)
)
)
)
)
Perl
{
'Action' => 'Add',
'RetargetingConditions' => [
{
'RetargetingConditionName' => 'Незавершенный заказ',
'RetargetingConditionDescription' => 'Положил товар в корзину, но заказ не оформил',
'Login' => 'agrom',
'RetargetingCondition' => [
{
'Type' => 'or',
'Goals' => [
{
'Time' => 14,
'GoalID' => 1557799
},
{
'Time' => 14,
'GoalID' => 1558005
}
]
},
{
'Type' => 'not',
'Goals' => [
{
'Time' => 11,
'GoalID' => 1559911
}
]
}
]
}
]
}