ArchiveBanners

Archives the ad.

Attention.

Disabled method. Use version 5 of the API.

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

For a method, there is a version of ArchiveBanners (Live).

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

Input data

The input data structure in JSON is shown below.

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

Parameters are described below.

ParameterDescriptionRequired
CampaignBidsInfo object
CampaignIDThe campaign ID.Yes
BannerIDSArray 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

{
   'CampaignID': 3665578,
   'BannerIDS': [20155899]
}

PHP

array(
   'CampaignID' => 3665578,
   'BannerIDS' => array(20155899)
)

Perl

{
   'CampaignID' => 3665578,
   'BannerIDS' => [20155899]
}