StopBanners (Live)

Stops displaying ads.

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.

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": "StopBanners",
   "param": {
      /* CampaignBidsInfo */
      "BannerIDS": [
         (long)
         ...
      ]
   }
}

Parameters are described below.

Parameter Description Required
CampaignBidsInfo object
BannerIDS Array containing IDs of ads that need to have impressions stopped (no more than 2000 IDs). Yes
Parameter Description Required
CampaignBidsInfo object
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. The value of the StatusShow parameter for ads takes the “No” value.

{
   "data": 1
}

Examples of input data

Python

{
   'BannerIDS': [20155899]
}

PHP

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

Perl

{
   'BannerIDS' => [20155899]
}