update

Changes the parameters of keywords and autotargetings.

  1. Restrictions
  2. Request
  3. Response

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 */  
    }, ... ] /* required */
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / UpdateRequest structure (for SOAP)
Keywordsarray of KeywordUpdateItemKeywords and autotargetings to change the parameters for.Yes
KeywordUpdateItem structure
IdlongID of the keyword or autotargeting.Yes
Keywordstring

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
UserParam1string, nillableValue of the {param1} substitution variable. Maximum of 255 characters.No
UserParam2string, nillableValue of the {param2} substitution variable. Maximum of 255 characters.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 */
  }
}
ParameterTypeDescription
Result structure (for JSON) / UpdateResponse structure (for SOAP)
UpdateResultsarray of ActionResultResults of changing parameters of keywords and autotargetings.
ActionResult structure
IdlongID of the changed keyword or autotargeting. Returned if there aren't any errors. See the section Operations on object arrays.
Warningsarray of ExceptionNotification

Warnings that occurred during the operation.

Errorsarray of ExceptionNotification

Errors that occurred during the operation.