update

Изменяет параметры фильтров — условий нацеливания для смарт-баннеров.

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

Ограничения

Не более 1000 фильтров в одном вызове метода.

Запрос

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

{
  "method": "update",
  "params": { /* params */
    "SmartAdTargets" : [{ /* SmartAdTargetUpdateItem */
      "Id": (long), /* required */
      "Name": (string),
      "AverageCpc": (long), /* nillable */
      "AverageCpa": (long), /* nillable */
      "StrategyPriority": ( "LOW" | "NORMAL" | "HIGH" ),
      "Audience": ( "INTERESTED_IN_SIMILAR_PRODUCTS" | "VISITED_PRODUCT_PAGE" | "ALL_SEGMENTS" ),
      "Conditions": { /* ConditionsArray */ 
        "Items": [{ /* ConditionsItem */ 
          "Operand": (string), /* required */
          "Operator": ( "GREATER_THAN" | "LESS_THAN" | "IN_RANGE" | "EXISTS" | "EQUALS_ANY" | "CONTAINS_ANY" | "NOT_CONTAINS_ALL" ), /* required */
          "Arguments": [(string), ... ] /* required */
        }, ... ] /* required */
      },
      "AvailableItemsOnly": ( "YES" | "NO" )
    }, ... ]  /* required */
  }
} 
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / AddRequest (для SOAP)
SmartAdTargets array of SmartAdTargetUpdateItem Фильтры. Да
Структура SmartAdTargetUpdateItem
Id long Идентификатор фильтра. Да
Name string Название фильтра (не более 100 символов). Нет
AverageCpc long, nillable Средняя цена клика, умноженная на 1 000 000. Целое число.

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

Нет
AverageCpa long, nillable Средняя цена конверсии, умноженная на 1 000 000. Целое число.

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

Нет
StrategyPriority PriorityEnum

Приоритет: LOW, NORMAL или HIGH. Используется только для стратегии AVERAGE_ROI.

Нет
Audience AudienceEnum Целевая аудитория:
  • INTERESTED_IN_SIMILAR_PRODUCTS — пользователи, которые интересовались похожими товарами в сети.
  • VISITED_PRODUCT_PAGE — пользователи, которые смотрели товары на сайте рекламодателя.
  • ALL_SEGMENTS — обе группы.
Нет
Conditions 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)
SmartAdTargets array of SmartAdTargetUpdateItem Фильтры. Да
Структура SmartAdTargetUpdateItem
Id long Идентификатор фильтра. Да
Name string Название фильтра (не более 100 символов). Нет
AverageCpc long, nillable Средняя цена клика, умноженная на 1 000 000. Целое число.

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

Нет
AverageCpa long, nillable Средняя цена конверсии, умноженная на 1 000 000. Целое число.

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

Нет
StrategyPriority PriorityEnum

Приоритет: LOW, NORMAL или HIGH. Используется только для стратегии AVERAGE_ROI.

Нет
Audience AudienceEnum Целевая аудитория:
  • INTERESTED_IN_SIMILAR_PRODUCTS — пользователи, которые интересовались похожими товарами в сети.
  • VISITED_PRODUCT_PAGE — пользователи, которые смотрели товары на сайте рекламодателя.
  • ALL_SEGMENTS — обе группы.
Нет
Conditions 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 */
    "UpdateResults": [{  /* ActionResult */
      "Id": (long),
      "Warnings": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ],
      "Errors": [{  /* ExceptionNotification */
        "Code": (int), /* required */
        "Message": (string), /* required */
        "Details": (string)
       }, ...
      ] 
    }, ... ] /* required */
  }
}
Параметр Тип Описание
Структура result (для JSON) / UpdateResponse (для SOAP)
UpdateResults array of ActionResult Результаты изменения параметров фильтров.
Структура ActionResult
Id long Идентификатор фильтра. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов.
Warnings array of ExceptionNotification

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

Errors array of ExceptionNotification

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

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

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

Errors array of ExceptionNotification

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