unarchive

Unarchives ads.

  1. Restrictions
  2. Request
  3. Response

Restrictions

A maximum of 10,000 ads per method call.

Ads can't be unarchived if they are in an archived campaign.

Request

Input data structure in JSON format:

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

Response

Response structure in JSON format:

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