Add

Добавляет ретаргетинги для групп объявлений.

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

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

{
   "method": "Retargeting",
   "param": {
      /* RetargetingRequest */
      "Action": (string),
      "Login": (string),
      "Retargetings": [
         {  /* Retargeting */
            "AdID": (long),
            "RetargetingConditionID": (int),
            "ContextPrice": (float),
            "Currency": (string),
            "AutoBudgetPriority": (string),
            "StatusPaused": (string)
         }
         ...
      ]
   }
}

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

Параметр	Описание	Требуется
Объект RetargetingRequest
`Action`	Выполняемая операция: Add.	Да
`Login`	Логин клиента, для которого нужно добавить ретаргетинги. Для рекламодателей параметр игнорируется.	Для агентств
`Retargetings`	Массив объектов `Retargeting`, содержащих параметры ретаргетинга для объявлений.	Да
Объект Retargeting
`AdID`	Идентификатор объявления.	Да
`RetargetingConditionID`	Идентификатор условия ретаргетинга. Допускается только условие ретаргетинга, содержащее по крайней мере одну группу с типом all или or.	Да
`ContextPrice`	Ставка в Рекламной сети Яндекса при использовании стратегий MaximumCoverage и Default (в валюте, указанной в параметре `Currency`). Максимальное и минимальное значения представлены в таблице {#T}. Если для кампании выбрана автоматическая стратегия показа, то передаваемое значение игнорируется, выдается предупреждение 209.	При использовании ручных стратегий
`Currency`	Валюта, в которой указана ставка. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой клиента, в противном случае возвращается ошибка с кодом 245.	Да
`AutoBudgetPriority`	Приоритет ретаргетинга при использовании автоматических стратегий. Возможные значения: Low — низкий приоритет; Medium — средний приоритет; High — высокий приоритет. Высокий приоритет обеспечивает на 10–15% больше показов, чем по фразам/ретаргетингам со средним приоритетом. Низкий приоритет уменьшает показы на такую же величину. Если в объявлении только один ретаргетинг и отсутствуют фразы, параметр не влияет на количество показов. Значение по умолчанию — Medium. Если для кампании выбрана ручная стратегия показа, то передаваемое значение сохраняется, но не влияет на показы.	Нет
`StatusPaused`	Ретаргетинг временно отключен (не используется для показа объявления) — Yes/No. Предустановленное значение — No.	Нет

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

Внимание

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

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

{
   "data": {
      /* RetargetingResponse */
      "ActionsResult": [
         {  /* RetargetingActionResult */
            "Warnings": [
               {  /* Warning */
                  "WarningCode": (int),
                  "WarningString": (string),
                  "Description": (string)
               }
               ...
            ],
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ],
            "RetargetingID": (int)
         }
         ...
      ]
   }
}

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

Параметр	Описание
Объект RetargetingResponse
`ActionsResult`	Массив объектов `RetargetingActionResult`. Каждый объект соответствует элементу входного массива `Retargetings` и содержит: в случае успешного выполнения операции — идентификатор ретаргетинга; если операция была выполнена, однако при ее выполнении возникли особенности — идентификатор ретаргетинга и массив `Warnings`, содержащий описание особенностей; в случае ошибки — массив `Errors`. Элементы массива следуют в том же порядке, что и объекты входного массива `Retargetings`.
Объект RetargetingActionResult
`Warnings`	Массив объектов `Warning` — предупреждений, возникших при выполнении операции.
`Errors`	Массив объектов `Error` — ошибок, возникших при выполнении операции.
`RetargetingID`	Идентификатор ретаргетинга.
Объект Warning
`WarningCode`	Код предупреждения: 208, 209 или 210.
`WarningString`	Текст предупреждения.
`Description`	Описание предупреждения в формате JSON. Вместе с `WarningCode` позволяет автоматически идентифицировать проблему.
Объект Error
`FaultCode`	Код ошибки.
`FaultString`	Текст сообщения об ошибке.
`FaultDetail`	Подробное описание причины ошибки.

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

Python

{
   'Action': 'Add',
   'Login': 'agrom', 
   'Retargetings': [
      {
         'AdID': 2571700,
         'RetargetingConditionID': 4533,
         'ContextPrice': 1.7
      }
   ]
}

PHP

array(
   'Action' => 'Add',
   'Login' => 'agrom',
   'Retargetings' => array(
      array(
         'AdID' => 2571700,
         'RetargetingConditionID' => 4533,
         'ContextPrice' =1.7
      )
   )
)

Perl

{
   'Action' => 'Add',
   'Login' => 'agrom',
   'Retargetings' => [
      {
         'AdID' => 2571700,
         'RetargetingConditionID' => 4533,
         'ContextPrice' =1.7
      }
   ]
}

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

Ретаргетинг (Retargeting)

Была ли статья полезна?

Retargeting (Live)

Update