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 */
  } 
}
ParameterTypeDescriptionRequired
Params structure (for JSON) / ArchiveRequest structure (for SOAP)
SelectionCriteriaIdsCriteriaCriteria for selecting ads to archive.Yes
IdsCriteria structure
Idsarray of longIDs 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 */
  }
}
ParameterTypeDescription
Result structure (for JSON) / ArchiveResponse structure (for SOAP)
ArchiveResultsarray of ActionResultResults of archiving 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.