update

Изменяет параметры ключевых фраз и автотаргетингов.

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

Ограничения

Не более 1000 объектов в одном вызове метода.

Запрос

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

{
  "method": "update",
  "params": { /* params */
    "Keywords": [{  /* KeywordUpdateItem */
      "Id": (long), /* required */
      "Keyword": (string),
      "UserParam1": (string), /* nillable */
      "UserParam2": (string), /* nillable */
      "AutotargetingCategories" : [{  /* AutotargetingCategoriesUpdateItem */
        "Category" : ("EXACT"|"ALTERNATIVE"|"COMPETITOR"|"BROADER"|"ACCESSORY") /* required */,
        "Value" : ("YES"|"NO") /* required */
      }, ...],
      "AutotargetingSettings" : {
        "Categories" : {
            "Exact" : ("YES"|"NO"),
            "Narrow" : ("YES"|"NO"),
            "Alternative" : ("YES"|"NO"),
            "Accessory" : ("YES"|"NO"),
            "Broader" : ("YES"|"NO")
        },
        "BrandOptions" : {
            "WithoutBrands" : ("YES"|"NO"),
            "WithAdvertiserBrand" : ("YES"|"NO"),
            "WithCompetitorsBrand" : ("YES"|"NO")
        }
      }
    }, ... ] /* required */
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / UpdateRequest (для SOAP)

Keywords

array of KeywordUpdateItem

Ключевые фразы и автотаргетинги, параметры которых требуется изменить.

Да

Структура KeywordUpdateItem

Id

long

Идентификатор ключевой фразы или автотаргетинга.

Да

Keyword

string

Ключевая фраза.

Может содержать минус-слова, которые указывают со знаком минус перед словом, например молния -гром -дождь.

Длина ключевой фразы — не более 4096 символов. Оператор ! перед минус-словом не учитывается в длине фразы (последовательность -! считается как один символ).

Не более 7 слов в ключевой фразе, без учета стоп-слов и минус-слов. Каждое слово — не более 35 символов, без учета минуса перед минус-словом.

Внимание

Для автотаргетинга поле Keyword изменить нельзя. Не передавайте это поле, либо передавайте значение ---autotargeting — оно игнорируется, остальные настройки обновляются. При передаче любого другого значения, включая пустую строку, возвращается ошибка и изменения автотаргетинга не применяются.

Нет

UserParam1

string, nillable

Значение подстановочной переменной{param1}. Не более 255 символов.

Нет

UserParam2

string, nillable

Значение подстановочной переменной{param2}. Не более 255 символов.

Нет

AutotargetingCategories

array of AutotargetingCategoriesUpdateItem

Структура устарела и больше не поддерживается.

Нельзя одновременно передать AutotargetingCategories и AutotargetingSettings, вернется ошибка валидации.

Категории таргетинга, которые требуется обновить.

Нет

AutotargetingSettings

AutotargetingSettingsUpdateItem

Настройки таргетинга, которые требуется обновить.

Нет

Структура AutotargetingCategoriesUpdateItem

Category

AutotargetingCategoriesEnum

Параметр устарел и скоро перестанет поддерживаться.

Настройки, заданные с помощью API, сконвертируются в веб-интерфейсе по следующим правилам:

API

Веб-интерфейс

Включенная категория EXACT.

  • Если в группе отключены категории «Целевые», «Узкие» – Включенные категории «Целевые», «Узкие».
  • Если в группе включены категории «Целевые» и/или «Узкие» – без изменений.

Выключенная категория EXACT.

  • Если в группе включены категории «Целевые» и/или «Узкие» – Выключенные категории «Целевые», «Узкие».
  • Если в группе отключены категории «Целевые», «Узкие» – без изменений.

Включенная категория COMPETITOR (если это единственная включенная категория).

Включенная опция упоминания брендов «Конкуренты» + отключение остальных опций упоминания брендов + включение всех категорий.

Включенная категория COMPETITOR (если это не единственная включенная категория).

Включенная опция упоминания брендов «Конкуренты».

Выключенная категория COMPETITOR.

Выключенная опция упоминания брендов «Конкуренты».

Категория таргетинга:

  • EXACT — целевые запросы. Объявление точно отвечает на запросы пользователя;
  • ALTERNATIVE — альтернативные запросы. Пользователь ищет продукт, который можно заменить продвигаемым. При этом объявление также может удовлетворить запрос;
  • COMPETITOR — запросы с упоминанием конкурентов. Поиск продвигаемого продукта у конкурентов;
  • BROADER — широкие запросы. Запросы с интересом к продукту, примером которого является предложение;
  • ACCESSORY — сопутствующие запросы. Запросы по продуктам, которые могут быть интересны вместе с продвигаемым товаром или услугой.

Да

Value

YesNoEnum

Признак включения указанной категории таргетинга. По умолчанию включены все категории таргетинга.

Да

Структура AutotargetingSettingsUpdateItem

Categories

AutotargetingSettingsCategoriesFieldNames

Категории таргетинга. Доступные опции:

  • Exact – целевые запросы. Объявление точно отвечает на запросы пользователя.
  • Narrow – узкие запросы. Объявление шире, чем запросы пользователя.
  • Alternative – альтернативные запросы. Пользователь ищет продукт, который можно заменить продвигаемым. При этом объявление также может удовлетворить запрос.
  • Accessory – сопутствующие запросы. Запросы по продуктам, которые могут быть интересны вместе с продвигаемым товаром или услугой.
  • Broader – широкие запросы. Запросы с интересом к продукту, примером которого является предложение.

Нет

BrandOptions

AutotargetingSettingsBrandOptionsFieldNames

Настройки брендовости. Доступные опции:

  • WithoutBrands – без упоминания брендов.
  • WithAdvertiserBrand – с упоминанием бренда пользователя.
  • WithCompetitorsBrand – с упоминанием брендов конкурентов.

Нет

Ответ

Структура ответа в формате 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

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