StopBanners

Stops displaying ads.

Alert

Disabled method. Use version 5 of the API.

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

The StopBanners (Live) version also exists for this method.

For ads that are stopped, the StatusShow parameter is set to “No”. A short time after stopping displays, the IsActive parameter is automatically assigned the “No” value, which means that displays are actually stopped.

Input data

The input data structure in JSON is shown below.

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

Parameters are described below.

^Parameter	^Description	^Required
_{CampaignBidsInfo object}
`CampaignID`	The campaign ID.	Yes
`BannerIDS`	Array containing IDs of ads that need to have impressions stopped (no more than 2000 IDs).	Yes

Output data

Returns 1 when executed 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]
}