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 символов, без учета минуса перед минус-словом. Внимание.
Для автотаргетинга значение недоступно для изменения. | Нет | ||||||||||||||||||||||||
UserParam1 | string, nillable | Значение подстановочной переменной {param1} . Не более 255 символов. | Нет | ||||||||||||||||||||||||
UserParam2 | string, nillable | Значение подстановочной переменной {param2} . Не более 255 символов. | Нет | ||||||||||||||||||||||||
AutotargetingCategories | array of AutotargetingCategoriesUpdateItem | Категории таргетинга, которые требуется обновить. Внимание. Структура устарела и больше не поддерживается. Нельзя одновременно передать | Нет | ||||||||||||||||||||||||
AutotargetingSettings | AutotargetingSettingsUpdateItem | Настройки таргетинга, которые требуется обновить. | Нет | ||||||||||||||||||||||||
Структура AutotargetingCategoriesUpdateItem | |||||||||||||||||||||||||||
Category | AutotargetingCategoriesEnum | Категория таргетинга:
Внимание. Поле устарело и скоро перестанет поддерживаться. Настройки, заданные с помощью API, сконвертируются в веб-интерфейсе по следующим правилам:
| Да | ||||||||||||||||||||||||
Value | YesNoEnum | Признак включения указанной категории таргетинга. По умолчанию включены все категории таргетинга. | Да | ||||||||||||||||||||||||
Структура AutotargetingSettingsUpdateItem | |||||||||||||||||||||||||||
Categories | AutotargetingSettingsCategoriesFieldNames | Категории таргетинга. Доступные опции:
| Нет | ||||||||||||||||||||||||
BrandOptions | AutotargetingSettingsBrandOptionsFieldNames | Настройки брендовости. Доступные опции:
| Нет |
Параметр | Тип | Описание | Обяза-тельный | ||||||||||||||||||||||||
Структура 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 | Категории таргетинга, которые требуется обновить. Внимание. Структура устарела и больше не поддерживается. Нельзя одновременно передать | Нет | ||||||||||||||||||||||||
AutotargetingSettings | AutotargetingSettingsUpdateItem | Настройки таргетинга, которые требуется обновить. | Нет | ||||||||||||||||||||||||
Структура AutotargetingCategoriesUpdateItem | |||||||||||||||||||||||||||
Category | AutotargetingCategoriesEnum | Категория таргетинга:
Внимание. Поле устарело и скоро перестанет поддерживаться. Настройки, заданные с помощью API, сконвертируются в веб-интерфейсе по следующим правилам:
| Да | ||||||||||||||||||||||||
Value | YesNoEnum | Признак включения указанной категории таргетинга. По умолчанию включены все категории таргетинга. | Да | ||||||||||||||||||||||||
Структура AutotargetingSettingsUpdateItem | |||||||||||||||||||||||||||
Categories | AutotargetingSettingsCategoriesFieldNames | Категории таргетинга. Доступные опции:
| Нет | ||||||||||||||||||||||||
BrandOptions | AutotargetingSettingsBrandOptionsFieldNames | Настройки брендовости. Доступные опции:
| Нет |
Ответ
Структура ответа в формате 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 | Ошибки, возникшие при выполнении операции. |