Difference between revisions of "API"
Line 174: | Line 174: | ||
</pre> | </pre> | ||
</code> | </code> | ||
+ | ==Статистика по всем материалам кампании== | ||
+ | Для получения статистики по всем материалам кампании используется метод <b>ads.analytic.materials.get</b><br/> | ||
+ | |||
+ | <table> | ||
+ | <tr bgcolor = #DCDCDC> | ||
+ | <th width = 130 align = left>Параметры</th> | ||
+ | <th width = 300 align = left>Значение</th> | ||
+ | <th width = 350 align = left>Дополнительные атрибуты</th> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>campaign_id</td> | ||
+ | <td>id кампании</td> | ||
+ | <td>int (числовое значение), обязательный параметр</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>period</td> | ||
+ | <td>Способ группировки данных по датам: | ||
+ | <p>1. day — статистика по дням;</p> | ||
+ | <p>2. month — статистика по месяцам;</p> | ||
+ | <p>Временные ограничения задаются параметрами date_from и date_to</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_from</td> | ||
+ | <td>Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_to</td> | ||
+ | <td>Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <b>Результат:</b><br/> | ||
+ | Возвращает объект с данными | ||
+ | <code> | ||
+ | <pre> | ||
+ | { | ||
+ | response: { | ||
+ | count: %total items% | ||
+ | items: { | ||
+ | teaser_id | ||
+ | date | ||
+ | shows | ||
+ | clicks | ||
+ | ctr | ||
+ | cpm | ||
+ | money | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </pre> | ||
+ | </code> | ||
+ | ==Статистика по материалу== | ||
+ | Для получения статистики по материалу используется метод <b>ads.analytic.material.get</b><br/> | ||
+ | <table> | ||
+ | <tr bgcolor = #DCDCDC> | ||
+ | <th width = 130 align = left>Параметры</th> | ||
+ | <th width = 300 align = left>Значение</th> | ||
+ | <th width = 350 align = left>Дополнительные атрибуты</th> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>material_id</td> | ||
+ | <td>id материала</td> | ||
+ | <td>int (числовое значение), обязательный параметр</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>period</td> | ||
+ | <td>Способ группировки данных по датам: | ||
+ | <p>1. day — статистика по дням;</p> | ||
+ | <p>2. month — статистика по месяцам;</p> | ||
+ | <p>Временные ограничения задаются параметрами date_from и date_to</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_from</td> | ||
+ | <td>Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_to</td> | ||
+ | <td>Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <b>Результат:</b><br/> | ||
+ | Возвращает объект с данными | ||
+ | <code> | ||
+ | <pre> | ||
+ | { | ||
+ | response: { | ||
+ | count: %total items% | ||
+ | items: { | ||
+ | date | ||
+ | shows | ||
+ | clicks | ||
+ | ctr | ||
+ | cpm | ||
+ | money | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </pre> | ||
+ | </code> | ||
+ | ==Создание рекламной кампании== | ||
+ | Для для создания новой рекламной кампании используется метод <b>ads.campaigns.put</b>. Допустимое количество кампаний, создаваемых с помощью одного запроса — 50.<br/> | ||
+ | <table> | ||
+ | <tr bgcolor = #DCDCDC> | ||
+ | <th width = 130 align = left>Параметры</th> | ||
+ | <th width = 300 align = left>Значение</th> | ||
+ | <th width = 350 align = left>Дополнительные атрибуты</th> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>data</td> | ||
+ | <td>сериализованный JSON-массив объектов, описывающих создаваемые кампании. Описание объектов client_specification см. ниже.</td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>period</td> | ||
+ | <td>Способ группировки данных по датам: | ||
+ | <p>1. day — статистика по дням;</p> | ||
+ | <p>2. month — статистика по месяцам;</p> | ||
+ | <p>Временные ограничения задаются параметрами date_from и date_to</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_from</td> | ||
+ | <td>Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | <tr bgcolor = #F5F5F5> | ||
+ | <td>date_to</td> | ||
+ | <td>Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period: | ||
+ | <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p> | ||
+ | <p>2. month: YYYY-MM, пример: 2011-09</p> | ||
+ | </td> | ||
+ | <td>обязательный параметр, строка</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | <b>Результат:</b><br/> | ||
+ | Возвращает объект с данными | ||
+ | <code> | ||
+ | <pre> | ||
+ | { | ||
+ | response: { | ||
+ | count: %total items% | ||
+ | items: { | ||
+ | date | ||
+ | shows | ||
+ | clicks | ||
+ | ctr | ||
+ | cpm | ||
+ | money | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </pre> | ||
+ | </code | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | http://wiki.kadam.net/index.php?title=API |
Revision as of 10:17, 4 November 2015
Contents
Статистика по кампании
Для получения статистики по кампании используется метод ads.analytic.campaign.get
Параметры | Значение | Дополнительные атрибуты | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
campaign_id | id кампании | int (числовое значение), обязательный параметр | ||||||||||||||||||||||||||||||||||||||||||||
client_specification | ||||||||||||||||||||||||||||||||||||||||||||||
client_id | id клиента, в рекламном кабинете которого будет создаваться кампания. Так же может принимать значение app_id (самого себя) | обязательный параметр, int (числовое значение) | ||||||||||||||||||||||||||||||||||||||||||||
ad_format | Формат объявления:
10 - Тизерная; 20 - Баннерная; 30 - VK-message; 40 - Clickunder; 50 - Контекстная |
обязательный параметр, int (числовое значение) | ||||||||||||||||||||||||||||||||||||||||||||
cost_type | Способ оплаты:
0 - СРС; 1 - СРА; 2 - СРМ |
обязательный параметр, int (числовое значение) | ||||||||||||||||||||||||||||||||||||||||||||
Link_url | ссылка на рекламируемый объект в формате: http://yoursite.cоm | обязательный параметр, строка | ||||||||||||||||||||||||||||||||||||||||||||
sex | Пол:
3 - любой; 2 - мужской; 1 - женский |
int (числовое значение) | ||||||||||||||||||||||||||||||||||||||||||||
age | Возвраст, /data.ages | последовательность чисел, разделенных запятой | ||||||||||||||||||||||||||||||||||||||||||||
cpa_mode | Тип уведомлений о конверсий для CPA, /ads.targeting.modes.get | int (числовое значение), обязательное для CPA кампании | ||||||||||||||||||||||||||||||||||||||||||||
categories | идентификаторы категорий: /data.categories.get?ad_format=% category_id: {region_id: cost} |
|||||||||||||||||||||||||||||||||||||||||||||
tags | таргетинг по ключевым словам | последовательность ключевых слов, разделенных запятой: [“key1”, “key2”, .., “keyN”] Ключевые слова с ценой. Только для оплаты - за клики или за показы: {“key1”: “cost”, “key2”: “cost”, .., “keyN”: “cost”} cost - float |
||||||||||||||||||||||||||||||||||||||||||||
day_limit | Дневной лимит в рублях. Для все типов кроме clickunder | положительное число | ||||||||||||||||||||||||||||||||||||||||||||
all_limit | Общий лимит в рублях. Для все типов кроме clickunder | положительное число | ||||||||||||||||||||||||||||||||||||||||||||
click_limit | Максимальное кол. переходов в день. Для все типов кроме clickunder. За показы и за клики. | положительное число | ||||||||||||||||||||||||||||||||||||||||||||
conversion_limit | Максимальное кол. конверсий в день. Для все типов кроме clickunder. Только для CPA | положительное число | ||||||||||||||||||||||||||||||||||||||||||||
adult_content | присутсвие контента для взрослых в рекламной кампании:
0 - Нет; 1 - Да |
необязательный параметр, int (числовое значение), по умолчанию 0 | ||||||||||||||||||||||||||||||||||||||||||||
adult_site | Отображать объявления кампании на сайтах с контентом для взрослых:
0 - Нет; 1 - Да |
необязательный параметр, int (числовое значение), по умолчанию 0 | ||||||||||||||||||||||||||||||||||||||||||||
time_show | Временной таргетинг:
* - отображение в любые часы и дни недели {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]: {} - ‘mn’: ‘*’ - все часы понендельника</p> <p><pre> {} - ‘mn’: [0, .., 23] - часы через запятую</p> </td> <td>необязательный параметр, * по умолчанию</td> </tr> <tr bgcolor = #F5F5F5> <td>platforms</td> <td>таргетинг по платформам: /data.platforms</td> <td>последовательность чисел, разделенных запятой</td> </tr> <tr bgcolor = #F5F5F5> <td>browsers</td> <td>таргетинг по браузерам: /data.browsers</td> <td>последовательность чисел, разделенных запятой</td> </tr> <tr bgcolor = #F5F5F5> <td>black_list</td> <td>черный список площадок на которых не будет показана реклама</td> <td>последовательность чисел ID площадок, разделенных запятой</td> </tr> <tr bgcolor = #F5F5F5> <td>white_list</td> <td>белый список площадок на которых не будет показана реклама</td> <td>последовательность чисел ID площадок, разделенных запятой</td> </tr> <tr bgcolor = #F5F5F5> <td>black_list_ip</td> <td>блокировка по ip</td> <td>последовательность ip адресов, разделенных запятой</td> </tr> </table> <b>Результат:</b><br/> Возвращает объект с данными <code> <pre> { response: { count: %total items% items: { shows clicks ctr cpm money } } } </code> Статистика по всем материалам кампанииДля получения статистики по всем материалам кампании используется метод ads.analytic.materials.get
Результат: { response: { count: %total items% items: { teaser_id date shows clicks ctr cpm money } } }
Статистика по материалуДля получения статистики по материалу используется метод ads.analytic.material.get
Результат: { response: { count: %total items% items: { date shows clicks ctr cpm money } } }
Создание рекламной кампанииДля для создания новой рекламной кампании используется метод ads.campaigns.put. Допустимое количество кампаний, создаваемых с помощью одного запроса — 50.
Результат: { response: { count: %total items% items: { date shows clicks ctr cpm money } } } </code
|