Advertising campaign status
campaign/status
Parameters:
- token — authorization (string)
- id — id of the ad campaign (int)
ids - list of campaign IDs separated by commas (string, for example: "100001, 100002, 10003")You can specify an advertising campaign identifier (id) OR a list of advertising campaign identifiers (ids). If neither of these parameters is passed, the entire list of advertising campaigns will be displayed. - status - Advertising campaign status (string, by default: all advertising campaigns). Values:
- rejected — blocked by the moderator
- moderating — awaiting moderation
- stopped — the campaign has been stopped
- active — the campaign is active
- inactive — the campaign is inactive (it has no executions on the account)
- currency - currency (string, by default: account currency). Values:
- rub
- usd
- language - advertising campaign description language (string, by default: account language). Values:
- ru - Russian
- en - English
- es - Spanish
- pt - Portuguese
Limit on the number of advertising campaigns: 1000 pcs. To get a full list of advertising campaigns, use the parameter:
- pagination_skip - offset, number of missed ad campaigns (int)
Example of the method request:
<?php
$post = array(
'token' => $token,
'id' => 999999
);
if ($curl = curl_init()) {
curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/status');
curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
$out = curl_exec($curl);
echo $out;
curl_close($curl);
}
// Result:
{
"id": 999999,
"balance_actions": 2,
"actions_hour": 0,
"actions_today": 0,
"actions_month": 0,
"actions_all": 12,
"status": "stopped",
"one_action_cost": 0.786,
"one_action_currency": "₽",
"one_action_currency_iso": "RUB"
}
====================================================================================
<?php
$post = array(
'token' => $token
);
if ($curl = curl_init()) {
curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/status');
curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
$out = curl_exec($curl);
echo $out;
curl_close($curl);
}
// Result:
{
"campaigns": [
{
"id": 999999,
"balance_actions": 2,
"actions_hour": 0,
"actions_today": 0,
"actions_month": 0,
"actions_all": 12,
"status": "stopped",
"one_action_cost": 0.786,
"one_action_currency": "₽",
"one_action_currency_iso": "RUB"
},
{
"id": 999999,
"balance_actions": 2,
"actions_hour": 0,
"actions_today": 0,
"actions_month": 0,
"actions_all": 12,
"status": "stopped",
"one_action_cost": 0.786,
"one_action_currency": "₽",
"one_action_currency_iso": "RUB"
}
],
"error_code": 0
}
Possible values of the "status" field:
- rejected — blocked by the moderator.
- moderating — awaiting moderation.
- stopped — the campaign has been stopped.
- active — the campaign is active.
- inactive — the campaign is inactive (it has no executions on the account).