unarchive

Unarchives ads.

Learn more

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 the ads that you want to unarchive (no more than ids-select).

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.

Previous
Next