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 */
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / SuspendRequest structure (for SOAP)
SelectionCriteriaIdsCriteriaCriteria for selecting ads to suspend.Yes
IdsCriteria structure
Idsarray of longIDs 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 */
  }
}
ParameterTypeDescription
Result structure (for JSON) / SuspendResponse structure (for SOAP)
SuspendResultsarray of ActionResultResults of suspending ads.
ActionResult structure
IdlongThe ad ID. 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.