suspend

Stops ad displays.

  1. Restrictions
  2. Request
  3. Response

Restrictions

A maximum of 10,000 ads per method call.

Displays can't be suspended for archived ads or drafts of ads (see Ad status and state), or for ads that belong to an archived campaign.

Request

Request structure in JSON format:

{
  "method": "suspend",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */ 
    } /* required */
  } 
}
Parameter Type Description Required
Params structure (for JSON) / SuspendRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting ads to suspend. Yes
IdsCriteria structure
Ids array of long IDs of ads to suspend (maximum of 10,000). Yes
Parameter Type Description Required
Params structure (for JSON) / SuspendRequest structure (for SOAP)
SelectionCriteria IdsCriteria Criteria for selecting ads to suspend. Yes
IdsCriteria structure
Ids array of long IDs of ads to suspend (maximum of 10,000). Yes

Response

Response structure in JSON format:

{
  "result": { /* result */
    "SuspendResults": [{  /* 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) / SuspendResponse structure (for SOAP)
SuspendResults array of ActionResult Results of suspending ads.
ActionResult structure
Id long The ad ID. Returned if there aren't any 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.

Parameter Type Description
Result structure (for JSON) / SuspendResponse structure (for SOAP)
SuspendResults array of ActionResult Results of suspending ads.
ActionResult structure
Id long The ad ID. Returned if there aren't any 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.