archive

Restrictions

A maximum of 10,000 ads per method call.

If the ad was displayed, it can be archived only if the ad owner stopped displays (the SUSPENDED state). See Ad status and state. Drafts of ads and ads belonging to an archived campaign can't be archived.

Request

Request structure in JSON format:

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

Response

Response structure in JSON format:

{
  "result": { /* result */
    "ArchiveResults": [{  /* 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) / ArchiveResponse structure (for SOAP)
ArchiveResults array of ActionResult Results of archiving 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.