unarchive

Unarchives campaigns.## Learn more

Restrictions

Maximum of 1000 campaigns per method call.

You can't unarchive campaigns from the special archive (the CONVERTED state).

Maximum of 1000 unarchived campaigns per advertiser.

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 campaigns to unarchive.

Yes

IdsCriteria structure

Ids

array of long

IDs of campaigns to unarchive (maximum of 1000).

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 campaigns.

ActionResult structure

Id

long

The campaign 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