Інформація про РК
campaign/info
Параметри:
- token — авторизація (string)
- id — ідентифікатор РК (int )
category_id — ідентифікатор категорії (int )
parent — ідентифікатор рекламної кампанії батьківської кампанії (int )Необхідно вказати ідентифікатор РК (id) АБО ідентифікатор категорії (category_id) АБО ідентифікатор рекламної кампанії-батька (parent). Якщо не передати жодного з цих параметрів, буде виведено весь список РК. - currency — валюта (string, за замовчуванням: валюта облікового запису). Значення:
- rub
- usd
- language — мова опису рекламних кампаній (string, за замовчуванням: мова облікового запису). Значення:
- ru — російська
- en — англійська
- es — іспанська
- pt — португальська
- filter — фільтр списку рекламних кампаній (string, за замовчуванням: немає). Значення:
- active — запущені рекламні кампанії
- activity_hour — активність за поточну годину (оновлення о 00-х хвилинах кожної години)
- activity_day — активність за поточний день (оновлення о 00:00 відповідно до часового поясу облікового запису)
- activity_month — активність за поточний місяць (оновлення о 00:00 кожного першого дня місяця відповідно до часового поясу облікового запису)
- balance — з позитивним балансом рекламних кампаній
Ліміт за кількістю рекламних кампаній: 1000 шт. Щоб отримати повний список рекламних кампаній, використовується параметр:
- pagination_skip — зсув, кількість пропущених рекламних кампаній (int)
Приклад виклику методу:
<?php
$post = array(
'token' => $token,
'id' => 999999
);
if ($curl = curl_init()) {
curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/info');
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);
}
// Результат:
{
"id": "999999",
"type": "paid_se",
"type_name": "посещения из поисковика",
"date_begin": "14.06.2019 13:56",
"campaign": "mysite.com (https://google.ru: ключевая фраза)",
"one_action_cost": "0.786",
"one_action_currency": "₽",
"one_action_currency_iso": "RUB",
"balance_actions": "2996",
"actions_hour": "0",
"actions_hour_limit": "1",
"actions_today": "1",
"actions_today_limit": "0",
"actions_all": "0",
"actions_under_moderation": "0",
"comments": "",
"status": "active",
"category_id": "9999",
"category_name": "mysite.com",
"error_code": 0
}
====================================================================================
<?php
$post = array(
'token' => $token,
'id' => 999999
);
if ($curl = curl_init()) {
curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/info');
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);
}
// Результат:
{
"id": "999999",
"type": "paid_se",
"type_name": "посещения из поисковика",
"date_begin": "14.06.2019 13:56",
"campaign": "mysite.com (https://google.ru: ключевая фраза)",
"one_action_cost": "0.786",
"one_action_currency": "₽",
"balance_actions": "2996",
"actions_hour": "0",
"actions_hour_limit": "1",
"actions_today": "1",
"actions_today_limit": "0",
"actions_all": "0",
"actions_under_moderation": "0",
"comments": "",
"status": "active",
"category_id": "9999",
"category_name": "mysite.com",
"children": [
{
"id": 888888,
"url": "mysite.com",
"actions": "1000",
"period": "day",
"spreading": "normal",
"rejection": 0,
"outer_clicks": 0,
"actions_hour": 0,
"actions_hour_limit": 42,
"actions_today": 0,
"actions_today_limit": 1000,
"actions_month": 0,
"actions_all": 0,
"actions_under_moderation": "0",
"status": "moderating"
},
{
"id": 777777,
"url": "mysite.com",
"actions": "1000",
"period": "day",
"spreading": "normal",
"rejection": 0,
"outer_clicks": 0,
"actions_hour": 0,
"actions_hour_limit": 42,
"actions_today": 0,
"actions_today_limit": 1000,
"actions_month": 0,
"actions_all": 0,
"actions_under_moderation": "0",
"status": "moderating"
}
],
"error_code": 0
}
====================================================================================
<?php
$post = array(
'token' => $token,
'category_id' => 9999
);
if ($curl = curl_init()) {
curl_setopt($curl, CURLOPT_URL, 'https://www.ipweb.ru/api/v2/campaign/info');
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);
}
// Результат:
{
"campaigns": [
{
"id": "999999",
"type": "paid_se",
"type_name": "посещения из поисковика",
"date_begin": "14.06.2019 11:27",
"campaign": "mysite.com (https://google.ru: ключевая фраза 1)",
"one_action_cost": "0.786",
"one_action_currency": "₽",
"balance_actions": "0",
"actions_hour": "0",
"actions_hour_limit": "1",
"actions_today": "0",
"actions_today_limit": "0",
"actions_all": "0",
"actions_under_moderation": "0",
"comments": "тест",
"status": "stopped",
"category_id": "9999",
"category_name": "mysite.com"
},
{
"id": "999998",
"type": "paid_se",
"type_name": "посещения из поисковика",
"date_begin": "14.06.2019 13:56",
"campaign": "mysite.com (https://google.ru: ключевая фраза 2)",
"one_action_cost": "0.786",
"one_action_currency": "₽",
"balance_actions": "992",
"actions_hour": "0",
"actions_hour_limit": "1",
"actions_today": "0",
"actions_today_limit": "1",
"actions_all": "0",
"actions_under_moderation": "0",
"comments": "",
"status": "active",
"category_id": "9999",
"category_name": "mysite.com"
}
],
"error_code": 0
}
Можливі значення поля «Status»:
- rejected — заблокована модератором (тоді відповідь містить також поле з причиною 'reject_reason').
- moderating — очікує на модерацію.
- stopped — кампанія зупинена.
- active — кампанія активна.
- inactive — кампанія неактивна (у неї немає показів на рахунку).