API — различия между версиями

Материал из Справочник сервиса Kadam.net
Перейти к: навигация, поиск
Строка 185: Строка 185:
 
</code>
 
</code>
 
==Создание рекламной кампании==
 
==Создание рекламной кампании==
−
Для для создания новой рекламной кампании используется метод <b>ads.campaigns.put. Допустимое количество кампаний, создаваемых с помощью одного запроса — 50.</b><br/>
+
Для для создания новой рекламной кампании используется метод <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

Версия 15:01, 2 ноября 2015

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

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

Параметры Значение Дополнительные атрибуты
campaign_id id кампании int (числовое значение), обязательный параметр
region_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_from и date_to

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

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

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

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

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

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

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

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

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

Источник — «https://wiki.kadam.net/index.php?title=API&oldid=1836»