advCampaigns - список кампаний advStats - статистика по дням advStatsCampaigns - статистика по кампаниям advBalans - баланс рекламодателя advBlAdd - добавить сайт в блэклист advLauncher - запуск/остановка кампании advTeaser - массовая загрузка тизеров
advCampaigns
Выводит список всех рекламных кампаний пользователя.
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&apiAction=advCampaigns&format=json
advStats
Выводит статистику рекламодателя по дням.
Параметры:
- FromDate: начальная дата в формате d.m.Y
- ToDate: конечная дата в формате d.m.Y
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&apiAction=advStats&format=json&FromDate=01.06.2014&ToDate=14.06.2014
advStatsCampaigns
Выводит статистику рекламодателя по кампаниям.
Параметры:
- FromDate: начальная дата в формате d.m.Y
- ToDate: конечная дата в формате d.m.Y
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&apiAction=advStatsCampaigns&format=json&FromDate=01.06.2014&ToDate=14.06.2014
advBalans
Возвращает текущий баланс рекламодателя.
Пример запроса:
http://www.adhub.ru/api/?apiKey=KEY&apiAction=advBalans&format=json
advBlAdd
Добавить площадку в БЛ.
Параметры:
- SiteId: id сайта.
- CampaignId: id кампании, необязательный параметр, если вы не укажите его в запросе, то сайт будет добавлен в БЛ всех кампаний.
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&apiAction=advBlAdd&SiteId=12345&CampaignId=12345format=json
advLauncher
Запустить/остановить указанные кампании.
Параметры:
- Status: start или stop.
- CampaignId: список id кампаний через запятую. Если требуется действие только для одной кампании, просто пишем CampaignId=10001 без запятых.
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&format=json&apiAction=advLauncher&Status=Start&CampaignId=10001,10002,10003
advTeaser
Массовая загрузка тизеров в кампанию.
Ограничения:
- Максимальное количество тизеров для одной кампании: 30
- Максимальное количество загружаемых тизеров за один раз: 10
- Допускаются изображения: jpg jpeg gif png 200x200px не более 75kb.
- Заголовок обязателен, длина не более 75 символов.
- Текст объявления, длина не более 75 символов, может быть одинаковым с заголовком.
- Ссылка автоматически подгружается из кампании, но если она указывается явно, то домен объявления и домен кампании должны совпадать.
- Кампания создается вручную через интерфейс рекламодателя.
- Список всех кампаний можно получить с помощью метода advCampaigns. В ответе также будет указано текущее количество загруженных объявлений.
GET Параметры:
- CampaignId: id кампании, обязательно, передается в ссылке запроса.
POST параметры:
Обязательный массив ads, который содержит список объявлений к загрузке в формате:
array(2) { [0]=> array(5) { ["id"]=> string(8) "31231231" ["name"]=> string(6) "Заголовок тизера" ["text"]=> string(10) "Текст тизера" ["url"]=> string(51) "http://mydomain.com/?utm_source=adhub" ["image"]=> string(64) "https://mydomain.com/images/w6oy1428663241ophh70.gif" } [1]=> array(5) { ["id"]=> string(8) "54531231" ["name"]=> string(6) "Второй заголовок тизера" ["text"]=> string(10) "И текст тизера" ["url"]=> string(51) "http://mydomain.com/?utm_source=adhub" ["image"]=> string(64) "https://mydomain.com/images/w6oy1428663241ophh70.gif" } }
где:
name* - заголовок объявления, обязателен.
image* - ссылка на картинку на вашем сервере, обязательно.
text - расширенный текст объявления, если его нет, то присваивается заголовок объявления.
url - ссылка на лэндинг, можно не указывать, тогда подтянется общая ссылка из кампании.
id - необязательный параметр, ваш внутренний id, служит для удобства отслеживания, какие объявления из присланных добавлены, а какие отклонены с ошибками.
Кодировка UTF8!
Пример запроса:
https://adhub.ru/api/?apiKey=KEY&apiAction=advTeaser&CampaignId=12345
+ не забываем передать POST['ads']
PHP:
$ads = array();
$ads[] = array('id' => '1', 'name' => 'Test title 1', 'text' => 'Test text 1', 'image' => 'https://testurl.com/images/image1.gif'); $ads[] = array('id' => '2', 'name' => 'Test title 2', 'text' => 'Test text 2', 'image' => 'https://testurl.com/images/image2.gif');
$ch = curl_init();
$url = 'https://adhub.ru/api/?apiKey=KEY&apiAction=advTeaser&CampaignId=12345';
$fields['ads'] = $ads;
$postvars = http_build_query($fields);
$ch = curl_init();
curl_setopt($ch,CURLOPT_URL, $url); curl_setopt($ch,CURLOPT_POST, 1); curl_setopt($ch,CURLOPT_POSTFIELDS, $postvars); curl_setopt($ch,CURLOPT_RETURNTRANSFER, true); curl_setopt($ch,CURLOPT_CONNECTTIMEOUT ,3); curl_setopt($ch,CURLOPT_TIMEOUT, 20); $response = curl_exec($ch); print "curl response is: " . $response;
curl_close ($ch);
В ответ в случае отстутствия ошибок и успешной загрузки тизеров вы получите json массив с статусом success и ad_id объявления в системе:
curl response is: {"result":{"1":{"id":1,"status":"success","ad_id":41148},"2":{"id":2,"status":"success","ad_id":41149}},"status":"success"}
В случае если какой-то тизер пройдет с ошибками, он будет помечен статусом error и появится переменная error с описанием его ошибки:
curl response is: {"result":{"1":{"id":1,"status":"success","ad_id":41150},"2":{"id":2,"status":"success","ad_id":41151},"3":{"id":3,"status":"error","error":"Name length must be 3-75"}},"status":"success"}
|