ArchiveBanners (Live)

Archives the ad.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.

Only ads that are stopped can be archived. Archived ads have the StatusArchive parameter set to "Yes".

New in the Live 4 version

The CampaignID input parameter does not need to be set.

Input data

The input data structure in JSON is shown below.

{
   "method": "ArchiveBanners",
   "param": {
      /* CampaignBidsInfo */
      "BannerIDS": [
         (long)
         ...
      ]
   }
}

Parameters are described below.

Parameter Description Required
CampaignBidsInfo object
BannerIDS Array containing IDs of ads to move to the archive (no more than 2000 IDs). Yes
Parameter Description Required
CampaignBidsInfo object
BannerIDS Array containing IDs of ads to move to the archive (no more than 2000 IDs). Yes

Output data

Returns 1 when archived successfully, as shown in the following example.

{
   "data": 1
}

Examples of input data

Python

{
   'BannerIDS': [20155899]
}

PHP

array(
   'BannerIDS' => array(20155899)
)

Perl

{
   'BannerIDS' => [20155899]
}