Documentation

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": { 
    "Keywords
[no-highlight[

Keywords and autotargetings to change the parameters for.

Required

Yes

]no-highlight]
": [{ /* KeywordUpdateItem */ "Id
[no-highlight[

ID of the keyword or autotargeting.

Required

Yes

]no-highlight]
": (long), /* required */ "Keyword
[no-highlight[

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 “-!” is considered one character).

Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word and negative keyword can be up to 35 characters, not counting the minus sign before a negative keyword.

Attention! 

For autotargeting, the value can‘t be changed.

Required

No

]no-highlight]
": (string), "UserParam1
[no-highlight[

Value of the {param1}substitution variable. Maximum of 255 characters.

Required

No

]no-highlight]
": (string), /* nillable */ "UserParam2
[no-highlight[

Value of the {param2}substitution variable. Maximum of 255 characters.

Required

No

]no-highlight]
": (string) /* nillable */ }, ... ] /* required */ } }
Parameter Type Description Required
params structure (for JSON) / UpdateRequest structure (for SOAP)
Keywords array of KeywordUpdateItemKeywords and autotargetings to change the parameters for.Yes
KeywordUpdateItem structure
Id longID 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 “-!” is considered one character).

Maximum of 7 words per keyword, not counting stop words and negative keywords. Each word and negative keyword can be 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, nillableValue of the {param1} substitution variable. Maximum of 255 characters.No
UserParam2 string, nillableValue of the {param2} substitution variable. Maximum of 255 characters.No

Response

Response structure in JSON format:

{
  "result": {  
    "UpdateResults
[no-highlight[

Results of changing parameters of keywords and autotargetings.

]no-highlight]
": [{ /* ActionResult */ "Id
[no-highlight[

ID of the changed keyword or autotargeting. Returned if there are no errors; see the section Operations on object arrays.

]no-highlight]
": (long), "Warnings
[no-highlight[

Warnings that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ], "Errors
[no-highlight[

Errors that occurred during the operation.

]no-highlight]
": [{ /* ExceptionNotification */ "Code": (int), /* required */ "Message": (string), /* required */ "Details": (string) }, ... ] }, ... ] /* required */ } }
Parameter Type Description
result structure (for JSON) / UpdateResponse structure (for SOAP)
UpdateResults array of ActionResultResults of changing parameters of keywords and autotargetings.
ActionResult structure
Id longID of the changed keyword or autotargeting. Returned if there are no errors; see the section Operations on object arrays.
Warnings array of ExceptionNotification

Warnings that occurred during the operation.

Errors array of ExceptionNotification

Errors that occurred during the operation.