Suspend

Pauses impressions for keywords. The keywords may be for different campaigns or ad groups.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.

Restrictions

Attention. This method only supports campaigns with the “Text & Image Ads” type. To manage keywords in all types of campaigns, use the Keywords service in version 5 of the API.

For an ad group, at least one keyword or retargeting condition must be active. When trying to stop all active keywords in a group (when there aren't any active retargetings), an error will be output for each of these keywords with the code 195 (this error does not cause the entire operation to be canceled and does not affect the success of stopping keywords that are related to other groups).

Input data

The input data structure in JSON is shown below.

{
   "method": "Keyword",
   "param": {
      /* KeywordRequest */
      "Action": (string),
      "Login": (string),
      "KeywordIDS": [
         (long)
         ...
      ]
   }
}

Parameters are described below.

ParameterDescriptionRequired
KeywordRequest object
ActionAction: Suspend.Yes
Login

The username of the client to perform the operation for.

A direct advertiser can optionally specify the username of a chief representative.

For agencies
KeywordIDSArray of keywords IDs (maximum 10,000).Yes

Output data

Note. Errors that occur when pausing individual keywords (54 if the user doesn't have editing permissions for the keyword, 194, and 195) do not cause the entire operation to be canceled and do not affect the success of pausing other keywords.

The output data structure in JSON is shown below.

{
   "data": {
      /* KeywordResponse */
      "ActionsResult": [
         {  /* KeywordActionResult */
            "Warnings": [
               {  /* Warning */
                  "WarningCode": (int),
                  "WarningString": (string),
                  "Description": (string)
               }
               ...
            ],
            "Errors": [
               {  /* Error */
                  "FaultCode": (int),
                  "FaultString": (string),
                  "FaultDetail": (string)
               }
               ...
            ],
            "KeywordID": (long)
         }
         ...
      ]
   }
}

Parameters are described below.

ParameterDescription
KeywordResponse object
ActionsResult
Array of KeywordActionResult objects. Each object corresponds to an item in the KeywordIDS input array and contains:
  • Keyword ID.
  • Array of Errors or array of Warnings if they occurred when executing the operation on this keyword.
KeywordActionResult object
WarningsArray of Warning objects describing issues that occurred while performing the operation.
ErrorsArray of Error objects with errors that occurred while performing the operation.
KeywordIDKeyword ID.
Warning object
WarningCodeWarning code: 212.
WarningStringWarning text.
DescriptionContains an empty structure.
Error object
FaultCodeError code.
FaultStringTextual message about the error.
FaultDetailDetailed description of the reason for the error.

Examples of input data

Python

{
   'Action': 'Suspend',
   'Login': 'agrom',
   'KeywordIDS': [199381759,199482870,200725193]
}

PHP

array(
   'Action' => 'Suspend',
   'Login' => 'agrom',
   'KeywordIDS' => array(199381759,199482870,200725193)
)

Perl

{
   'Action' => 'Suspend',
   'Login' => 'agrom',
   'KeywordIDS' => [199381759,199482870,200725193]
}