add

Создает условия нацеливания для динамических объявлений, назначает ставки или приоритеты для создаваемых условий.

  1. Ограничения
  2. Запрос
  3. Ответ

Ставка или приоритет используются в зависимости от того, какая стратегия показа выбрана в кампании:

  • Если в кампании настроена автоматическая стратегия, то используется параметр StrategyPriority: объявления по условиям нацеливания для динамических объявлений с более высоким приоритетом по возможности получают больший объем трафика, а при недостатке бюджета отключаются в последнюю очередь.

  • Если в кампании настроена ручная стратегия, то используется параметр Bid.

Параметр ContextBid в настоящее время не используется.

В случае если элемент входного массива содержит параметры, не соответствующие стратегии, то значения этих параметров будут сохранены и будет выдано предупреждение.

  • Если в кампании настроена автоматическая стратегия, а для условия нацеливания для динамических объявлений задан параметр Bid, то это значение ставки не будет применено: в момент смены стратегии с автоматической на ручную будет задана ставка, подобранная автоматическим алгоритмом.

  • Если в кампании настроена ручная стратегия, а для условия нацеливания для динамических объявлений задан параметр StrategyPriority, то в дальнейшем в момент смены стратегии на автоматическую заданное значение приоритета будет применено.

Если стратегия предполагает назначение ставки, а ставка не указана, по умолчанию назначается минимальная ставка (зависит от валюты рекламодателя). Если стратегия предполагает назначение приоритета, а приоритет не указан, по умолчанию назначается средний приоритет.

Внимание.

  • Ставки и цены передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой ставку или цену, умноженную на 1 000 000.

  • Все ставки и цены указываются в валюте рекламодателя.

Ограничения

Условия нацеливания для динамических объявлений можно добавить только в группу объявлений с типом DYNAMIC_TEXT_AD_GROUP.

Не более 50 условий нацеливания для динамических объявлений в группе объявлений.

Не более 1000 условий нацеливания для динамических объявлений в одном вызове метода.

Запрос

Структура запроса в формате JSON:

{
  "method": "add",
  "params": {  /* params */
    "DynamicFeedAdTargets": [{  /* required */
      "Name": (string), /* required */
      "AdGroupId": (long), /* required */
      "Bid": (long),
      "ContextBid": (long),
      "Conditions" : {
        "Items" : [{ /* required */
          "Operand" : (string) /* required */,
          "Operator" : ( "CONTAINS_ANY" | "EQUALS_ANY" | "EXISTS" | "GREATER_THAN" | "IN_RANGE" | "LESS_THAN"| "NOT_CONTAINS_ALL") /* required */,
          "Arguments" : [ (string) ] /* required */
        }, ... ]
      },
      "AvailableItemsOnly" : ("YES"|"NO")
    }, ... ]
  }
}
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
DynamicFeedAdTargets array of DynamicFeedAdTargetAddItem Условия нацеливания для динамических объявлений, которые требуется добавить. Да
Структура DynamicFeedAdTargetAddItem
Name string Название условия нацеливания для динамических объявлений (не более 100 символов). Да
AdGroupId long Идентификатор группы, в которую добавляется условие нацеливания для динамических объявлений. Да
Bid long

Ставка на поиске, умноженная на 1 000 000. Целое число. Используется только для ручной стратегии.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

 Нет
ContextBid long Параметр зарезервирован для будущего использования. Нет
Conditions array of ConditionsArray

Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора.

Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL).
Ограничение. Если тип фида в группе объявлений — FLIGHTS или RETAIL, правила отбора не предусмотрены.
 Нет
AvailableItemsOnly YesNoEnum Отбирать только товары в наличии. Значение по умолчанию NO.

Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован.

 Нет
Структура ConditionsArray
Items array of ConditionsItem Правила отбора. Не более 30 фильтров в массиве. Суммарная длина правил отбора — не более 65 кБайт (в формате JSON). Да
Структура ConditionsItem
Operand string

Параметр фида.

Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа.

 Да
Operator StringConditionOperatorEnum

Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора.

 Да
Arguments array of string

Массив строк, с которыми сравнивается операнд.

 Да
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
DynamicFeedAdTargets array of DynamicFeedAdTargetAddItem Условия нацеливания для динамических объявлений, которые требуется добавить. Да
Структура DynamicFeedAdTargetAddItem
Name string Название условия нацеливания для динамических объявлений (не более 100 символов). Да
AdGroupId long Идентификатор группы, в которую добавляется условие нацеливания для динамических объявлений. Да
Bid long

Ставка на поиске, умноженная на 1 000 000. Целое число. Используется только для ручной стратегии.

Указывается в валюте рекламодателя. Ограничения представлены в справочнике валют, который можно получить с помощью метода Dictionaries.get, указав в запросе имя справочника Currencies.

 Нет
ContextBid long Параметр зарезервирован для будущего использования. Нет
Conditions array of ConditionsArray

Правила отбора товарных предложений. Товарное предложение отбирается для показа, если оно удовлетворяет одновременно всем правилам отбора.

Если параметр не задан, фильтр отбирает все товарные предложения из фида (тип отбора ITEMS_ALL).
Ограничение. Если тип фида в группе объявлений — FLIGHTS или RETAIL, правила отбора не предусмотрены.
 Нет
AvailableItemsOnly YesNoEnum Отбирать только товары в наличии. Значение по умолчанию NO.

Может быть использован только в фидах с типом Яндекс Маркет, в остальных фидах будет проигнорирован.

 Нет
Структура ConditionsArray
Items array of ConditionsItem Правила отбора. Не более 30 фильтров в массиве. Суммарная длина правил отбора — не более 65 кБайт (в формате JSON). Да
Структура ConditionsItem
Operand string

Параметр фида.

Описание полей для каждого типа фида см. в разделе Настройка фильтров помощи Директа.

 Да
Operator StringConditionOperatorEnum

Оператор сравнения. Совместимость полей фида и операторов, а также ограничения на значения см. разделе Правило отбора.

 Да
Arguments array of string

Массив строк, с которыми сравнивается операнд.

 Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "AddResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ...  ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
      }, ...  ] 
    }, ...  ]
  }
}
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления условий нацеливания для динамических объявлений.
Структура ActionResult
Id long Идентификатор созданного условия нацеливания для динамических объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.
Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.
Параметр Тип Описание
Структура result (для JSON) / AddResponse (для SOAP)
AddResults array of ActionResult Результаты добавления условий нацеливания для динамических объявлений.
Структура ActionResult
Id long Идентификатор созданного условия нацеливания для динамических объявлений. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

Предупреждения, возникшие при выполнении операции.
Errors array of ExceptionNotification

Ошибки, возникшие при выполнении операции.