update
Changes the parameters of keywords and autotargetings.
Restrictions
Maximum of 1000 objects per method call.
Request
Request structure in JSON format:
{
"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 */
}
}
Parameter | Type | Description | Required | ||||||||||||||||||||||||
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Keywords | array of KeywordUpdateItem | Keywords and autotargetings to change the parameters for. | Yes | ||||||||||||||||||||||||
KeywordUpdateItem structure | |||||||||||||||||||||||||||
Id | long | ID of the keyword or autotargeting. | Yes | ||||||||||||||||||||||||
Keyword | string | Keywords. It can contain negative keywords, which are specified with the minus sign before the word, such as lightning -thunder -rain. The maximum length of a keyword is 4096 characters. The “!” operator before a negative keyword is not counted in the keyword length (the sequence “-!” counts as a single character). Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word can have up to 35 characters, not counting the minus sign before a negative keyword. Attention.
For autotargeting, the value can't be changed. | No | ||||||||||||||||||||||||
UserParam1 | string, nillable | The value of the {param1} substitution variable. Maximum of 255 characters. | No | ||||||||||||||||||||||||
UserParam2 | string, nillable | The value of the {param2} substitution variable. Maximum of 255 characters. | No | ||||||||||||||||||||||||
AutotargetingCategories | array of AutotargetingCategoriesUpdateItem | Targeting categories to update. Attention. This structure is obsolete and no longer supported. You can't pass both | No | ||||||||||||||||||||||||
AutotargetingSettings | AutotargetingSettingsUpdateItem | Targeting settings to update. | No | ||||||||||||||||||||||||
AutotargetingCategoriesUpdateItem structure | |||||||||||||||||||||||||||
Category | AutotargetingCategoriesEnum | Targeting category:
Attention. This field is deprecated and will soon cease to be supported. The settings specified using the API are converted for the web interface as follows:
| Yes | ||||||||||||||||||||||||
Value | YesNoEnum | The flag indicating that the specified targeting category is enabled. All targeting categories are enabled by default. | Yes | ||||||||||||||||||||||||
AutotargetingSettingsUpdateItem structure | |||||||||||||||||||||||||||
Categories | AutotargetingSettingsCategoriesFieldNames | Targeting categories. Available options:
| No | ||||||||||||||||||||||||
BrandOptions | AutotargetingSettingsBrandOptionsFieldNames | Brand mention settings. Available options:
| No |
Parameter | Type | Description | Required | ||||||||||||||||||||||||
Params structure (for JSON) / UpdateRequest structure (for SOAP) | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Keywords | array of KeywordUpdateItem | Keywords and autotargetings to change the parameters for. | Yes | ||||||||||||||||||||||||
KeywordUpdateItem structure | |||||||||||||||||||||||||||
Id | long | ID of the keyword or autotargeting. | Yes | ||||||||||||||||||||||||
Keyword | string | Keywords. It can contain negative keywords, which are specified with the minus sign before the word, such as lightning -thunder -rain. The maximum length of a keyword is 4096 characters. The “!” operator before a negative keyword is not counted in the keyword length (the sequence “-!” counts as a single character). Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word can have up to 35 characters, not counting the minus sign before a negative keyword. Attention.
For autotargeting, the value can't be changed. | No | ||||||||||||||||||||||||
UserParam1 | string, nillable | The value of the {param1} substitution variable. Maximum of 255 characters. | No | ||||||||||||||||||||||||
UserParam2 | string, nillable | The value of the {param2} substitution variable. Maximum of 255 characters. | No | ||||||||||||||||||||||||
AutotargetingCategories | array of AutotargetingCategoriesUpdateItem | Targeting categories to update. Attention. This structure is obsolete and no longer supported. You can't pass both | No | ||||||||||||||||||||||||
AutotargetingSettings | AutotargetingSettingsUpdateItem | Targeting settings to update. | No | ||||||||||||||||||||||||
AutotargetingCategoriesUpdateItem structure | |||||||||||||||||||||||||||
Category | AutotargetingCategoriesEnum | Targeting category:
Attention. This field is deprecated and will soon cease to be supported. The settings specified using the API are converted for the web interface as follows:
| Yes | ||||||||||||||||||||||||
Value | YesNoEnum | The flag indicating that the specified targeting category is enabled. All targeting categories are enabled by default. | Yes | ||||||||||||||||||||||||
AutotargetingSettingsUpdateItem structure | |||||||||||||||||||||||||||
Categories | AutotargetingSettingsCategoriesFieldNames | Targeting categories. Available options:
| No | ||||||||||||||||||||||||
BrandOptions | AutotargetingSettingsBrandOptionsFieldNames | Brand mention settings. Available options:
| No |
Response
Response structure in JSON format:
{
"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 */
}
}
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing parameters of keywords and autotargetings. |
ActionResult structure | ||
Id | long | ID of the changed keyword or autotargeting. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing parameters of keywords and autotargetings. |
ActionResult structure | ||
Id | long | ID of the changed keyword or autotargeting. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |