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

Материал из Справочник сервиса Kadam.net
Перейти к: навигация, поиск
Строка 308: Строка 308:
 
       <td>необязательный параметр, * по умолчанию</td>
 
       <td>необязательный параметр, * по умолчанию</td>
 
   </tr>
 
   </tr>
−
<tr bgcolor = #F5F5F5>
+
  <tr bgcolor = #F5F5F5>
 
       <td>platforms</td>
 
       <td>platforms</td>
 
       <td>таргетинг по платформам:  /data.platforms</td>  
 
       <td>таргетинг по платформам:  /data.platforms</td>  
Строка 339: Строка 339:
 
<pre>  102 - unknown client
 
<pre>  102 - unknown client
 
   103 - overlimit campaigns</pre>
 
   103 - overlimit campaigns</pre>
 +
 +
==Редактирование рекламных кампаний==
 +
Для редактирования рекламных кампаний используется метод <b>ads.campaigns.update</b>. Максимальное допустимое количество кампаний, редактируемых с помощью одного запроса — 50.<br>
 +
Version log: 1.0.1 - добавлен параметр status
 +
<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_mod_specification см. ниже.</td>
 +
      <td>обязательный параметр, строка</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>client_specification</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>campaign_id</td>
 +
      <td>id редактируемой кампании
 +
      </td>
 +
      <td>обязательный параметр, положительное число</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>name</td>
 +
      <td>название кампании</td>
 +
      <td>необязательный параметр, строка длиной от 3 до 60 символов</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>link_url</td>
 +
      <td>ссылка на рекламируемый объект в формате http://yoursite.cоm</td>
 +
      <td>необязательный параметр, строка</td>
 +
  </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>необязательный параметр, int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>categories</td>
 +
      <td>идентификаторы категорий
 +
          <p>/data.categories.get?ad_format=%</p>
 +
          <p>category_id: {region_id: cost}</p>
 +
      </td>
 +
      <td>необязательный параметр</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>tags</td>
 +
      <td>таргетинг по ключевым словам</td>
 +
      <td>необязательный параметр, последовательность ключевых слов, разделенных запятой</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>day_limit</td>
 +
      <td>дневной лимит в рублях. для всех типов кроме clickunder</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>&nbsp;&nbsp; * - отображение в любые часы и дни недели</p>
 +
          <p>&nbsp;&nbsp; {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:</p>
 +
          <p>&nbsp;&nbsp; {} - ‘mn’: ‘*’ - все часы понендельника</p>
 +
          <p>&nbsp;&nbsp; {} - ‘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>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>status</td>
 +
      <td>запуск/приостановка кампании:
 +
          <p>0 - приостановлена;</p>
 +
          <p>1 - запущена</p>
 +
      </td>
 +
      <td>необязательный параметр, int (числовое значение), по умолчанию 1</td>
 +
  </tr>
 +
</table>

Версия 12:06, 4 ноября 2015

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

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

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

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

month - статистика по месяцам

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

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

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

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

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

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

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

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

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

{
	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.

Параметры Значение Дополнительные атрибуты
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’: ‘*’ - все часы понендельника

   {} - ‘mn’: [0, .., 23] - часы через запятую

 необязательный параметр, * по умолчанию
platforms таргетинг по платформам: /data.platforms последовательность чисел, разделенных запятой
browsers таргетинг по браузерам: /data.browsers последовательность чисел, разделенных запятой
black_list черный список площадок на которых не будет показана реклама последовательность чисел ID площадок, разделенных запятой
white_list белый список площадок на которых не будет показана реклама последовательность чисел ID площадок, разделенных запятой
black_list_ip блокировка по ip последовательность ip адресов, разделенных запятой

Результат:
Возвращает массив ответов на запросы в массиве data. Соответствующий объект в выходном массиве содержит id созданной кампании, и поля error_code и error_descв случае возникновения ошибки.

Errors:

   102 - unknown client
   103 - overlimit campaigns

Редактирование рекламных кампаний

Для редактирования рекламных кампаний используется метод ads.campaigns.update. Максимальное допустимое количество кампаний, редактируемых с помощью одного запроса — 50.
Version log: 1.0.1 - добавлен параметр status

Параметры Значение Дополнительные атрибуты
data сериализованный JSON-массив объектов, описывающих изменения в кампаниях. Описание объектов client_mod_specification см. ниже. обязательный параметр, строка
client_specification
campaign_id id редактируемой кампании обязательный параметр, положительное число
name название кампании необязательный параметр, строка длиной от 3 до 60 символов
link_url ссылка на рекламируемый объект в формате http://yoursite.cоm необязательный параметр, строка
sex Пол:

3 - любой;

2 - мужской;

1 - женский

 необязательный параметр, int (числовое значение)
age возраст, /data.ages необязательный параметр, int (числовое значение)
categories идентификаторы категорий

/data.categories.get?ad_format=%

category_id: {region_id: cost}

 необязательный параметр
tags таргетинг по ключевым словам необязательный параметр, последовательность ключевых слов, разделенных запятой
day_limit дневной лимит в рублях. для всех типов кроме clickunder необязательный параметр, положительное число
adult_content присутсвие контента для взрослых в рекламной кампании:

0 - Нет;

1 - Да

 необязательный параметр, int (числовое значение), по умолчанию 0
adult_site отображать объявления кампании на сайтах с контентом для взрослых:

0 - Нет;

1 - Да

 необязательный параметр, int (числовое значение), по умолчанию 0
time_show Временной таргетинг:

   * - отображение в любые часы и дни недели

   {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:

   {} - ‘mn’: ‘*’ - все часы понендельника

   {} - ‘mn’: [0, .., 23] - часы через запятую

 необязательный параметр, * по умолчанию
platforms таргетинг по платформам: /data.platforms последовательность чисел, разделенных запятой
browsers таргетинг по браузерам: /data.browsers последовательность чисел, разделенных запятой
black_list черный список площадок на которых не будет показана реклама последовательность чисел ID площадок, разделенных запятой
white_list белый список площадок на которых не будет показана реклама последовательность чисел ID площадок, разделенных запятой
black_list_ip блокировка по ip последовательность ip адресов, разделенных запятой
status запуск/приостановка кампании:

0 - приостановлена;

1 - запущена

 необязательный параметр, int (числовое значение), по умолчанию 1
Источник — «https://wiki.kadam.net/index.php?title=API&oldid=1860»