Difference between revisions of "API"

From Service Manual Kadam.net
Jump to: navigation, search
Line 14: Line 14:
 
   </tr>
 
   </tr>
 
   <tr bgcolor = #F5F5F5>
 
   <tr bgcolor = #F5F5F5>
−
       <td>region_id</td>
+
       <td>client_specification</td>
−
      <td>id региона</td>
+
−
      <td>int (числовое значение), обязательный параметр</td>
+
 
   </tr>
 
   </tr>
 
   <tr bgcolor = #F5F5F5>
 
   <tr bgcolor = #F5F5F5>
−
       <td>period</td>
+
       <td>client_id</td>
−
       <td>Способ группировки данных по датам:
+
       <td>id клиента, в рекламном кабинете которого будет создаваться кампания. Так же может принимать значение app_id (самого себя)
−
          <p>1. day — статистика по дням;</p>
+
−
          <p>2. month — статистика по месяцам;</p>
+
−
          <p>Временные ограничения задаются параметрами date_from и date_to</p>
+
 
       </td>
 
       </td>
−
       <td>обязательный параметр, строка</td>
+
       <td>обязательный параметр, int (числовое значение)</td>
 
   </tr>
 
   </tr>
 
   <tr bgcolor = #F5F5F5>
 
   <tr bgcolor = #F5F5F5>
−
       <td>date_from</td>
+
       <td>ad_format</td>
−
       <td>Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:  
+
       <td>Формат объявления:  
−
           <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p>
+
           <p>10 - Тизерная;</p>
−
           <p>2. month: YYYY-MM, пример: 2011-09</p>
+
          <p>20 - Баннерная;</p>
−
           <p>Временные ограничения задаются параметрами date_from и date_to</p>
+
          <p>30 - VK-message;</p>
 +
           <p>40 - Clickunder;</p>
 +
           <p>50 - Контекстная</p>
 
       </td>
 
       </td>
−
       <td>обязательный параметр, строка</td>
+
       <td>обязательный параметр, int (числовое значение)</td>
 
   </tr>
 
   </tr>
 
   <tr bgcolor = #F5F5F5>
 
   <tr bgcolor = #F5F5F5>
−
       <td>date_to</td>
+
       <td>cost_type</td>
−
       <td>Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:  
+
       <td>Способ оплаты:  
−
           <p>1. day: YYYY-MM-DD, пример: 2011-09-27</p>
+
           <p>0 - СРС;</p>
−
           <p>2. month: YYYY-MM, пример: 2011-09</p>
+
           <p>1 - СРА;</p>
−
           <p>Временные ограничения задаются параметрами date_from и date_to</p>
+
           <p>2 - СРМ</p>
 +
      </td>
 +
      <td>обязательный параметр, int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>Link_url</td>
 +
      <td>ссылка на рекламируемый объект в формате: http://yoursite.cоm
 
       </td>
 
       </td>
 
       <td>обязательный параметр, строка</td>
 
       <td>обязательный параметр, строка</td>
 
   </tr>
 
   </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>sex</td>
 +
      <td>Пол:
 +
          <p>3 - любой;</p>
 +
          <p>2 - мужской;</p>
 +
          <p>1 - женский</p>
 +
      </td>
 +
      <td>int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>age</td>
 +
      <td>Возвраст, /data.ages</td>
 +
      <td>последовательность чисел, разделенных запятой</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>cpa_mode</td>
 +
      <td>Тип уведомлений о конверсий для CPA, /ads.targeting.modes.get</td>
 +
      <td>int (числовое значение), обязательное для CPA кампании</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>categories</td>
 +
      <td><p>идентификаторы категорий:</p>
 +
          <p>/data.categories.get?ad_format=%</p>
 +
          <p>category_id: {region_id: cost}</p>
 +
      </td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>tags</td>
 +
      <td>таргетинг по ключевым словам</td>
 +
      <td><p>последовательность ключевых слов, разделенных запятой: [“key1”, “key2”, .., “keyN”]</p>
 +
          <p>Ключевые слова с ценой. Только для оплаты - за клики или за показы: {“key1”: “cost”, “key2”: “cost”, .., “keyN”: “cost”}</p>
 +
          <p>cost - float</p>
 +
      </td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>day_limit</td>
 +
      <td>Дневной лимит в рублях. Для все типов кроме clickunder</td>
 +
      <td>положительное число</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>all_limit</td>
 +
      <td>Общий лимит в рублях. Для все типов кроме clickunder</td>
 +
      <td>положительное число</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>click_limit</td>
 +
      <td>Максимальное кол. переходов в день. Для все типов кроме clickunder. За показы и за клики.</td>
 +
      <td>положительное число</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>conversion_limit</td>
 +
      <td>Максимальное кол. конверсий в день. Для все типов кроме clickunder. Только для CPA</td>
 +
      <td>положительное число</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>adult_content</td>
 +
      <td>присутсвие контента для взрослых в рекламной кампании:
 +
          <p>0 - Нет;</p>
 +
          <p>1 - Да</p>
 +
      </td>
 +
      <td>необязательный параметр, int (числовое значение), по умолчанию 0</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>adult_site</td>
 +
      <td>Отображать объявления кампании на сайтах с контентом для взрослых:
 +
          <p>0 - Нет;</p>
 +
          <p>1 - Да</p>
 +
      </td>
 +
      <td>необязательный параметр, int (числовое значение), по умолчанию 0</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>time_show</td>
 +
      <td>Временной таргетинг:
 +
          <p>* - отображение в любые часы и дни недели</p>
 +
          <p>{} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:</p>
 +
          <p><pre>    {} - ‘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>
 
</table>
  

Revision as of 15:52, 2 November 2015

Статистика по кампании

Для получения статистики по кампании используется метод 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

Параметры Значение Дополнительные атрибуты
campaign_id id кампании int (числовое значение), обязательный параметр
period Способ группировки данных по датам:

1. day — статистика по дням;

2. month — статистика по месяцам;

Временные ограничения задаются параметрами date_from и date_to

 обязательный параметр, строка
date_from Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка
date_to Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка

Результат:
Возвращает объект с данными 

{
	response: {
		count: %total items%
		items: {
			teaser_id
			date
			shows
			clicks
			ctr
			cpm
			money
                       }
                  }
}

Статистика по материалу

Для получения статистики по материалу используется метод ads.analytic.material.get

Параметры Значение Дополнительные атрибуты
material_id id материала int (числовое значение), обязательный параметр
period Способ группировки данных по датам:

1. day — статистика по дням;

2. month — статистика по месяцам;

Временные ограничения задаются параметрами date_from и date_to

 обязательный параметр, строка
date_from Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка
date_to Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка

Результат:
Возвращает объект с данными 

{
	response: {
		count: %total items%
		items: {
			date
			shows
			clicks
			ctr
			cpm
			money
                       }
                  }
}

Создание рекламной кампании

Для для создания новой рекламной кампании используется метод ads.campaigns.put. Допустимое количество кампаний, создаваемых с помощью одного запроса — 50.

Параметры Значение Дополнительные атрибуты
data сериализованный JSON-массив объектов, описывающих создаваемые кампании. Описание объектов client_specification см. ниже. обязательный параметр, строка
period Способ группировки данных по датам:

1. day — статистика по дням;

2. month — статистика по месяцам;

Временные ограничения задаются параметрами date_from и date_to

 обязательный параметр, строка
date_from Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка
date_to Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:

1. day: YYYY-MM-DD, пример: 2011-09-27

2. month: YYYY-MM, пример: 2011-09

 обязательный параметр, строка

Результат:
Возвращает объект с данными 

{
	response: {
		count: %total items%
		items: {
			date
			shows
			clicks
			ctr
			cpm
			money
                       }
                  }
}

</code

Retrieved from "https://wiki.kadam.net/en/index.php?title=API&oldid=1837"