StopCampaign (Live)
Stops displaying the ads in the campaign.
Alert
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.
When the method is invoked, the StatusShow parameter automatically switches to “No”, but impressions might continue for a short time. The true end of impressions is indicated by the “No” value in the IsActive parameter.
Restrictions
Alert
This method only supports campaigns with the “Text & Image Ads” type. To work with all types of campaigns, use the Campaigns service in version 5 of the API. More information about campaign types
Input data
The input data structure in JSON is shown below.
{
"method": "StopCampaign",
"param": {
/* CampaignIDInfo */
"CampaignID": (int)
}
}
Parameters are described below.
|
Parameter |
Description |
Required |
|
CampaignIDInfo object |
||
|
|
The campaign ID. |
Yes |
Output data
Returns 1 when executed successfully, as shown in the following example.
{
"data": 1
}
Examples of input data
Python
{
'CampaignID': 3665578
}
PHP
array(
'CampaignID' =3665578
)
Perl
{
'CampaignID' =3665578
}