Get

Возвращает параметры ретаргетингов.

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

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

{
   "method": "Retargeting",
   "param": {
      /* RetargetingRequest */
      "Action": (string),
      "Login": (string),
      "SelectionCriteria": {
         /* RetargetingSelectionCriteria */
         "RetargetingConditionIDS": [
            (int)
            ...
         ],
         "RetargetingIDS": [
            (int)
            ...
         ],
         "AdIDS": [
            (long)
            ...
         ]
      },
      "Options": {
        "Currency": (string)
      }
   }
}

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

Параметр

Описание

Требуется

Объект RetargetingRequest

Action

Выполняемая операция: Get.

Да

Login

Логин клиента, для которого нужно получить ретаргетинги.

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

Для агентств

SelectionCriteria

Объект RetargetingSelectionCriteria, задающий критерии отбора ретаргетингов.

Да

Options

Объект RetargetingRequestOptions, задающий параметры ответа.

Да

Объект RetargetingSelectionCriteria

RetargetingConditionIDS

Массив идентификаторов условий ретаргетинга, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве.

Один из параметров — RetargetingConditionIDS, RetargetingIDS или AdIDS

RetargetingIDS

Массив идентификаторов ретаргетингов, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве.

AdIDS

Массив идентификаторов объявлений, для которых необходимо выполнить операцию. Не более 1000 элементов в массиве.

Объект RetargetingRequestOptions

Currency

Валюта, в которой должны быть выражены ставки в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой клиента, в противном случае возвращается ошибка с кодом 245.

Да

Примечание

Если в структуре SelectionCriteria задано более одного критерия, операция будет выполнена для ретаргетингов, отвечающих одновременно всем критериям. Например, если указаны параметры RetargetingConditionIDS и AdIDS, операция будет выполнена для ретаргетингов, у которых идентификатор условия содержится в массиве RetargetingConditionIDS, а идентификатор объявления содержится в массиве AdIDS.

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

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

{
   "data": {
      /* RetargetingResponse */
      "Retargetings": [
         {  /* Retargeting */
            "RetargetingID": (int),
            "AdID": (long),
            "AdGroupID": (long),
            "RetargetingConditionID": (int),
            "ContextPrice": (float),
            "Currency": (string),
            "AutoBudgetPriority": (string),
            "StatusPaused": (string)
         }
         ...
      ]
   }
}

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

Параметр

Описание

Объект RetargetingResponse

Retargetings

Массив объектов Retargeting.

Объект Retargeting

RetargetingID

Идентификатор ретаргетинга.

AdGroupID

Идентификатор группы объявлений.

AdID

Идентификатор объявления.

RetargetingConditionID

Идентификатор условия ретаргетинга.

ContextPrice

Ставка в Рекламной сети Яндекса при использовании стратегий MaximumCoverage и Default (в валюте, указанной в параметре Currency).

Currency

Валюта, в которой выражена ставка.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN.

AutoBudgetPriority

Приоритет ретаргетинга при использовании автоматических стратегий. Возможные значения:

  • Low — низкий приоритет;
  • Medium — средний приоритет;
  • High — высокий приоритет.

StatusPaused

Ретаргетинг временно отключен (не используется для показа объявления) — 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]
   }
}

Узнайте больше

Предыдущая
Следующая