update

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

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

Ограничения

Не более 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 символов, без учета минуса перед минус-словом.

Внимание.

Для автотаргетинга значение недоступно для изменения.

Нет
UserParam1 string, nillable Значение подстановочной переменной {param1}. Не более 255 символов. Нет
UserParam2 string, nillable Значение подстановочной переменной {param2}. Не более 255 символов. Нет
AutotargetingCategories array of AutotargetingCategoriesUpdateItem

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

Внимание.

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

Нет
AutotargetingSettings AutotargetingSettingsUpdateItem Настройки таргетинга, которые требуется обновить. Нет
Структура AutotargetingCategoriesUpdateItem
Category AutotargetingCategoriesEnum

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Да
Value YesNoEnum Признак включения указанной категории таргетинга. По умолчанию включены все категории таргетинга. Да
Структура AutotargetingSettingsUpdateItem
Categories AutotargetingSettingsCategoriesFieldNames

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

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

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

  • WithoutBrands – без упоминания брендов.
  • WithAdvertiserBrand – с упоминанием бренда рекламодателя.
  • WithCompetitorsBrand – с упоминанием брендов конкурентов.
Нет
Параметр Тип Описание Обяза-тельный
Структура params (для JSON) / UpdateRequest (для SOAP)
Keywords array of KeywordUpdateItem Ключевые фразы и автотаргетинги, параметры которых требуется изменить. Да
Структура KeywordUpdateItem
Id long Идентификатор ключевой фразы или автотаргетинга. Да
Keyword string

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

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

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

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

Внимание.

Для автотаргетинга значение недоступно для изменения.

Нет
UserParam1 string, nillable Значение подстановочной переменной {param1}. Не более 255 символов. Нет
UserParam2 string, nillable Значение подстановочной переменной {param2}. Не более 255 символов. Нет
AutotargetingCategories array of AutotargetingCategoriesUpdateItem

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

Внимание.

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

Нет
AutotargetingSettings AutotargetingSettingsUpdateItem Настройки таргетинга, которые требуется обновить. Нет
Структура AutotargetingCategoriesUpdateItem
Category AutotargetingCategoriesEnum

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Да
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

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

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

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

Errors array of ExceptionNotification

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