Get
Возвращает параметры ретаргетингов.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "Retargeting",
"param": {
/* RetargetingRequest */
"Action": (string),
"Login": (string),
"SelectionCriteria": {
/* RetargetingSelectionCriteria */
"RetargetingConditionIDS": [
(int)
...
],
"RetargetingIDS": [
(int)
...
],
"AdIDS": [
(long)
...
]
},
"Options": {
"Currency": (string)
}
}
}
Ниже приведено описание параметров.
Параметр |
Описание |
Требуется |
Объект RetargetingRequest |
||
|
Выполняемая операция: Get. |
Да |
|
Логин клиента, для которого нужно получить ретаргетинги. Для рекламодателей параметр игнорируется. |
Для агентств |
|
Объект |
Да |
|
Объект |
Да |
Объект RetargetingSelectionCriteria |
||
|
Массив идентификаторов условий ретаргетинга, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве. |
Один из параметров — |
|
Массив идентификаторов ретаргетингов, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве. |
|
|
Массив идентификаторов объявлений, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве. |
|
Объект RetargetingRequestOptions |
||
|
Валюта, в которой должны быть выражены ставки в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой клиента, в противном случае возвращается ошибка с кодом 245. |
Да |
Примечание |
||
Если в структуре |
Результирующие данные
Ниже показана структура результирующих данных в формате JSON.
{
"data": {
/* RetargetingResponse */
"Retargetings": [
{ /* Retargeting */
"RetargetingID": (int),
"AdID": (long),
"AdGroupID": (long),
"RetargetingConditionID": (int),
"ContextPrice": (float),
"Currency": (string),
"AutoBudgetPriority": (string),
"StatusPaused": (string)
}
...
]
}
}
Ниже приведено описание параметров.
Параметр |
Описание |
Объект RetargetingResponse |
|
|
Массив объектов |
Объект Retargeting |
|
|
Идентификатор ретаргетинга. |
|
Идентификатор группы объявлений. |
|
Идентификатор объявления. |
|
Идентификатор условия ретаргетинга. |
|
Ставка в Рекламной сети Яндекса при использовании стратегий MaximumCoverage и Default (в валюте, указанной в параметре |
|
Валюта, в которой выражена ставка. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. |
|
Приоритет ретаргетинга при использовании автоматических стратегий. Возможные значения:
|
|
Ретаргетинг временно отключен (не используется для показа объявления) — Yes/No. Предустановленное значение — No. |
Примеры входных данных
Python
{
'Action': 'Get',
'SelectionCriteria': {
'AdIDS': [2571703, 2571705, 2571707]
}
}
PHP
array(
'Action' => 'Get',
'SelectionCriteria' => array(
'AdIDS' => array(2571703, 2571705, 2571707)
)
)
Perl
{
'Action' => 'Get',
'SelectionCriteria' ={
'AdIDS' => [2571703, 2571705, 2571707]
}
}