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 */
      "AutotargetingCategories" : [{  /* AutotargetingCategoriesUpdateItem */
        "Category" : ("EXACT"|"ALTERNATIVE"|"COMPETITOR"|"BROADER"|"ACCESSORY") /* required */,
        "Value" : ("YES"|"NO") /* required */
      }, ...]  
    }, ... ] /* 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 be added. No
AutotargetingCategoriesUpdateItem structure
Category AutotargetingCategoriesEnum

Targeting category:

  • EXACT: The targeted queries. The ad perfectly matches user queries.
  • ALTERNATIVE: Alternative queries. The user is looking for a product that can be replaced by the advertised product. The ad might also match the query in this case.
  • COMPETITOR: Queries mentioning competitors. Searching competitors for the advertised product.
  • BROADER: Broad queries. Queries showing interest in a product exemplified by the ad.
  • ACCESSORY: Related queries. Queries for products that might interest the user in relation to the advertised product or service.
Attention.

This field is deprecated and will soon stop being supported.

Your settings from the API are converted for the web interface as follows:

API Web interface

Enabled EXACT category.

Enabled “Targeted” and “Narrow” categories.

Enabled COMPETITOR category (if this is the only enabled category).

Enabled “Competitors” brand mention option + all other brand mention options are disabled + all categories are enabled.

Enabled COMPETITOR category (if this isn't the only enabled category).

Enabled “Competitors” brand mention option.

Disabled COMPETITOR category.

Disabled “Competitors” brand mention option.

API Web interface

Enabled EXACT category.

Enabled “Targeted” and “Narrow” categories.

Enabled COMPETITOR category (if this is the only enabled category).

Enabled “Competitors” brand mention option + all other brand mention options are disabled + all categories are enabled.

Enabled COMPETITOR category (if this isn't the only enabled category).

Enabled “Competitors” brand mention option.

Disabled COMPETITOR category.

Disabled “Competitors” brand mention option.

Yes
Value YesNoEnum The flag indicating that the specified targeting category is enabled. All targeting categories are enabled by default. Yes
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 be added. No
AutotargetingCategoriesUpdateItem structure
Category AutotargetingCategoriesEnum

Targeting category:

  • EXACT: The targeted queries. The ad perfectly matches user queries.
  • ALTERNATIVE: Alternative queries. The user is looking for a product that can be replaced by the advertised product. The ad might also match the query in this case.
  • COMPETITOR: Queries mentioning competitors. Searching competitors for the advertised product.
  • BROADER: Broad queries. Queries showing interest in a product exemplified by the ad.
  • ACCESSORY: Related queries. Queries for products that might interest the user in relation to the advertised product or service.
Attention.

This field is deprecated and will soon stop being supported.

Your settings from the API are converted for the web interface as follows:

API Web interface

Enabled EXACT category.

Enabled “Targeted” and “Narrow” categories.

Enabled COMPETITOR category (if this is the only enabled category).

Enabled “Competitors” brand mention option + all other brand mention options are disabled + all categories are enabled.

Enabled COMPETITOR category (if this isn't the only enabled category).

Enabled “Competitors” brand mention option.

Disabled COMPETITOR category.

Disabled “Competitors” brand mention option.

API Web interface

Enabled EXACT category.

Enabled “Targeted” and “Narrow” categories.

Enabled COMPETITOR category (if this is the only enabled category).

Enabled “Competitors” brand mention option + all other brand mention options are disabled + all categories are enabled.

Enabled COMPETITOR category (if this isn't the only enabled category).

Enabled “Competitors” brand mention option.

Disabled COMPETITOR category.

Disabled “Competitors” brand mention option.

Yes
Value YesNoEnum The flag indicating that the specified targeting category is enabled. All targeting categories are enabled by default. Yes

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.