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

Материал из Справочник сервиса Kadam.net
Перейти к: навигация, поиск
Строка 301: Строка 301:
 
       <td>time_show</td>
 
       <td>time_show</td>
 
       <td>Временной таргетинг:  
 
       <td>Временной таргетинг:  
−
           <p>&nbsp&nbsp * - отображение в любые часы и дни недели</p>
+
           <p>&nbsp;&nbsp; * - отображение в любые часы и дни недели</p>
−
           <p>&nbsp&nbsp {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:</p>
+
           <p>&nbsp;&nbsp; {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:</p>
 
       </td>
 
       </td>
 
       <td>необязательный параметр, * по умолчанию</td>
 
       <td>необязательный параметр, * по умолчанию</td>

Версия 11:37, 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"]:

 необязательный параметр, * по умолчанию




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

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







http://wiki.kadam.net/index.php?title=API

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