Работа с ретаргетинговыми кампаниями — различия между версиями

Материал из Справочник сервиса Kadam.net
Перейти к: навигация, поиск
(Новая страница: «==Статистика по кампании== Для получения статистики по кампании используется метод <b>ads.ana…»)
 
Строка 122: Строка 122:
 
</pre>
 
</pre>
 
</code>
 
</code>
 +
 +
==Статистика по кампании==
 +
Для получения статистики по кампании используется метод <b>ads.analytic.campaign.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>region_id</td>
 +
      <td>id региона: data.geo.regions.get</td>
 +
      <td>int (числовое значение), необязательный параметр</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>period</td>
 +
      <td>Способ группировки данных по датам:
 +
          <p>day — статистика по дням;</p>
 +
          <p>month - статистика по месяцам</p>
 +
          <p>Временные ограничения задаются параметрами date_from и date_to</p>
 +
      </td>
 +
      <td>обязательный параметр, строка</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>date_from</td>
 +
      <td>Начальная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:
 +
          <p>day: YYYY-MM-DD, пример: 2011-09-27;</p>
 +
          <p>month: YYYY-MM, пример: 2011-09</p>
 +
      </td>
 +
      <td>обязательный параметр, строка</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>date_to</td>
 +
      <td>Конечная дата выводимой статистики. Используется разный формат дат для разного значения параметра period:
 +
          <p>day: YYYY-MM-DD, пример: 2011-09-27;</p>
 +
          <p>month: YYYY-MM, пример: 2011-09</p>
 +
      </td>
 +
      <td>обязательный параметр, строка</td>
 +
  </tr>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает объект с данными
 +
<code>
 +
<pre>
 +
{
 +
response: {
 +
count: %total items%
 +
items: {
 +
shows
 +
clicks
 +
ctr
 +
cpm
 +
money
 +
                      }
 +
                  }
 +
}
 +
</pre>
 +
</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><br>
 +
Допустимое количество кампаний, создаваемых с помощью одного запроса — 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>client_specification</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>client_id</td>
 +
      <td>id клиента, в рекламном кабинете которого будет создаваться кампания. Так же может принимать значение app_id (самого себя)
 +
      </td>
 +
      <td>обязательный параметр, int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>ad_format</td>
 +
      <td>Формат объявления:
 +
          <p>10 - Тизерная;</p>
 +
          <p>20 - Баннерная;</p>
 +
          <p>30 - VK-message;</p>
 +
          <p>40 - Clickunder;</p>
 +
          <p>60 - Контекстная</p>
 +
      </td>
 +
      <td>обязательный параметр, int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>cost_type</td>
 +
      <td>Способ оплаты:
 +
          <p>0 - СРС;</p>
 +
          <p>1 - СРА;</p>
 +
          <p>2 - СРМ</p>
 +
      </td>
 +
      <td>обязательный параметр, int (числовое значение)</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>последовательность чисел, разделенных запятой</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>&nbsp;&nbsp; * - отображение в любые часы и дни недели</p>
 +
          <p>&nbsp;&nbsp; {} - массив, где ключ имя дня недели ["Sn","Mn","Tu","Wd","Th","Fr","Sa"]:</p>
 +
          <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {} - ‘mn’: ‘*’ - все часы понендельника</p>
 +
          <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&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>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на запросы в массиве data. Соответствующий объект в выходном массиве содержит id созданной кампании, и поля error_code и error_desc в случае возникновения ошибки.
 +
<p>Errors:</p>
 +
<pre>  102 - unknown client
 +
  103 - overlimit campaigns</pre>
 +
 +
==Редактирование рекламных кампаний==
 +
Для редактирования рекламных кампаний используется метод <b>ads.campaigns.update</b><br>
 +
Максимальное допустимое количество кампаний, редактируемых с помощью одного запроса — 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;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {} - ‘mn’: ‘*’ - все часы понендельника</p>
 +
          <p>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&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>
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на каждый запрос в массиве data. Соответствующий объект в выходном массиве содержит id изменяемого клиента и, в случае возникновения ошибки, поля error_code и error_desc.
 +
<p>Errors:</p>
 +
<pre>  100 - unknown campaign
 +
  102 - unknown client</pre>
 +
 +
==Список кампаний рекламного кабинета==
 +
Для получения списка кампаний рекламного кабинета используется метод <b>ads.campaigns.get</b>
 +
 +
<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>client_id</td>
 +
      <td>Идентификатор клиента, у которого запрашиваются рекламные кампании</td>
 +
      <td>int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>include_archive</td>
 +
      <td>Флаг, задающий необходимость вывода архивных объявлений:
 +
          <p>0 - выводить только активные кампании;</p>
 +
          <p>1 - выводить все кампании</p>
 +
      </td>
 +
      <td>Флаг, может принимать значения 1 или 0</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>campaign_ids</td>
 +
      <td>Фильтр выводимых рекламных кампаний.
 +
          <p>Сериализованный JSON-массив, содержащий id кампаний. Выводиться будут только кампании, присутствующие в campaign_ids и являющиеся кампаниями указанного рекламного кабинета. Если параметр равен null, то выводиться будут все кампании.</p>
 +
      </td>
 +
      <td>Строка</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>limit</td>
 +
      <td>ограничение на количество возвращаемых кампаний. Используется, только если параметр campaign_ids равен null</td>
 +
      <td>int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>offset</td>
 +
      <td>смещение. Используется в тех же случаях, что и параметр limit</td>
 +
      <td>int (числовое значение)</td>
 +
  </tr>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает массив объектов campaign, каждый из которых содержит следующие поля:
 +
<code>
 +
<pre>
 +
response: {
 +
      count: %total%,
 +
      items: [{
 +
  id — идентификатор кампании
 +
  name — название кампании
 +
  status — статус кампании (0 — кампания остановлена, 1 — кампания запущена, 2 — кампания удалена)
 +
  day_limit — дневной лимит кампании в рублях (0 — лимит не задан)
 +
  all_limit — общий лимит кампании в рублях (0 — лимит не задан)
 +
  ad_format — формат объявления
 +
  cost_type — тип оплаты
 +
  link_url - ссылка на рекламируемый объект
 +
  sex - пол
 +
  age - возраст
 +
  regions - идентификаторы регионов
 +
  categories - идентификаторы категорий.
 +
  adult_content - присутсвие контент для взрослых
 +
  adult_site - отображение объявлений кампании на сайтах с контентом для взрослых
 +
      },..]
 +
}
 +
</pre>
 +
</code>
 +
<p>Errors:</p>
 +
<pre>  102 - unknown client</pre>
 +
 +
==Архивирование клиентов рекламного агенства==
 +
Для архивирования клиентов рекламного агенства используется метод <b>ads.campaigns.delete</b><br>
 +
Максимальное допустимое количество клиентов, редактируемых с помощью одного запроса — 10.<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>ids</td>
 +
      <td>Список id кампаний через запятую или массив с id кампаниями.
 +
          <p>Например:</p>
 +
          <p>“id1, id2, …, idn“ или [id1, id2, …, idn]</p>
 +
      </td>
 +
      <td>обязательный параметр, строка</td>
 +
  </tr>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на каждый запрос. Каждый ответ является либо 0, что означает успешное удаление, либо массив error.
 +
<p>Errors:</p>
 +
<pre>  100 - unknown campaign
 +
  101 - campaign already archive
 +
  102 - unknown client</pre>
 +
 +
==Получение кодов для СРА кампаний==
 +
Для получения кодов по СРА кампаниям используется метод <b>ads.campaigns.cpa.mode.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>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает объект с данными.
 +
<code>
 +
<pre>
 +
{
 +
response: {
 +
url: %url%
 +
                  }
 +
}
 +
</pre>
 +
</code>
 +
 +
==Получение списка категорий по заданому фильтру==
 +
Для возврата списка категорий по заданому фильтру используется метод <b>ads.campaigns.categories.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>ad_format</td>
 +
      <td>формат объявления:
 +
            <p>ads.campaigns.foarmats.get</p>
 +
      </td>
 +
      <td>обязательный параметр, int (числовое значение)</td>
 +
  </tr>
 +
  <tr bgcolor = #F5F5F5>
 +
      <td>category_id</td>
 +
      <td>id категории. ограничивает отображение только по id категории</td>
 +
      <td>необязательный параметр,  int (числовое значение)</td>
 +
  </tr>
 +
</table>
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на запросы в массиве response.
 +
<code>
 +
<pre>
 +
response: {
 +
            count: %total%,
 +
            items: [{
 +
                      %category_id%: {
 +
                            %region_id%: {
 +
                        min: %min_cost%,
 +
                        max: %max_cost%
 +
                            }
 +
                      }
 +
                  },..]
 +
}
 +
</pre>
 +
</code>
 +
 +
==Получение списка форматов объявлений==
 +
Для получения списка форматов объявлений используется метод <b>ads.campaigns.formats.get</b><br/>
 +
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на запросы в массиве response.
 +
<code>
 +
<pre>
 +
response: {
 +
      count: %total%,
 +
      items: [{
 +
            id: %format_id%,
 +
            title: ‘%format title%’
 +
      },..]
 +
}
 +
</pre>
 +
</code>
 +
 +
==Получение списка платформ==
 +
Для получения списка платформ используется метод <b>ads.targeting.platforms.get</b><br/>
 +
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на запросы в массиве response. 
 +
<code>
 +
<pre>
 +
response: {
 +
      count: %,
 +
      items: [{
 +
          id: %platform_id%,
 +
          title: %platform_name%,
 +
          mobile: %is mobile%
 +
      },..]
 +
}
 +
</pre>
 +
</code>
 +
 +
==Получение списка браузеров==
 +
Для получения списка браузеров используется метод <b>ads.targeting.browsers.get</b><br/>
 +
 +
<b>Результат:</b><br/>
 +
Возвращает массив ответов на запросы в массиве response. 
 +
<code>
 +
<pre>
 +
response: {
 +
      count: %,
 +
      items: [{
 +
          id: %browser_id%,
 +
          title: %browser_name%,
 +
      },..]
 +
}
 +
</pre>
 +
</code>

Версия 08:57, 12 ноября 2015

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

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

Параметры Значение Дополнительные атрибуты
campaign_id id кампании int (числовое значение), обязательный параметр
region_id id региона: data.geo.regions.get 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.campaign.get

Параметры Значение Дополнительные атрибуты
campaign_id id кампании int (числовое значение), обязательный параметр
region_id id региона: data.geo.regions.get 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.

Параметры Значение Дополнительные атрибуты
data сериализованный JSON-массив объектов, описывающих создаваемые кампании. Описание объектов client_specification см. ниже. обязательный параметр, строка
client_specification
client_id id клиента, в рекламном кабинете которого будет создаваться кампания. Так же может принимать значение app_id (самого себя) обязательный параметр, int (числовое значение)
ad_format Формат объявления:

10 - Тизерная;

20 - Баннерная;

30 - VK-message;

40 - Clickunder;

60 - Контекстная

 обязательный параметр, 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

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

Errors:

   100 - unknown campaign
   102 - unknown client

Список кампаний рекламного кабинета

Для получения списка кампаний рекламного кабинета используется метод ads.campaigns.get

Параметры Значение Дополнительные атрибуты
client_id Идентификатор клиента, у которого запрашиваются рекламные кампании int (числовое значение)
include_archive Флаг, задающий необходимость вывода архивных объявлений:

0 - выводить только активные кампании;

1 - выводить все кампании

 Флаг, может принимать значения 1 или 0
campaign_ids Фильтр выводимых рекламных кампаний.

Сериализованный JSON-массив, содержащий id кампаний. Выводиться будут только кампании, присутствующие в campaign_ids и являющиеся кампаниями указанного рекламного кабинета. Если параметр равен null, то выводиться будут все кампании.

 Строка
limit ограничение на количество возвращаемых кампаний. Используется, только если параметр campaign_ids равен null int (числовое значение)
offset смещение. Используется в тех же случаях, что и параметр limit int (числовое значение)

Результат:
Возвращает массив объектов campaign, каждый из которых содержит следующие поля: 

response: {
       count: %total%,
       items: [{
	   id — идентификатор кампании
	   name — название кампании
	   status — статус кампании (0 — кампания остановлена, 1 — кампания запущена, 2 — кампания удалена)
	   day_limit — дневной лимит кампании в рублях (0 — лимит не задан)
	   all_limit — общий лимит кампании в рублях (0 — лимит не задан)
	   ad_format — формат объявления
	   cost_type — тип оплаты
	   link_url - ссылка на рекламируемый объект
	   sex - пол
	   age - возраст
	   regions - идентификаторы регионов
	   categories - идентификаторы категорий.
	   adult_content - присутсвие контент для взрослых
	   adult_site - отображение объявлений кампании на сайтах с контентом для взрослых
      },..]
}

Errors:

   102 - unknown client

Архивирование клиентов рекламного агенства

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

Параметры Значение Дополнительные атрибуты
ids Список id кампаний через запятую или массив с id кампаниями.

Например:

“id1, id2, …, idn“ или [id1, id2, …, idn]

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

Результат:
Возвращает массив ответов на каждый запрос. Каждый ответ является либо 0, что означает успешное удаление, либо массив error.

Errors:

   100 - unknown campaign
   101 - campaign already archive
   102 - unknown client

Получение кодов для СРА кампаний

Для получения кодов по СРА кампаниям используется метод ads.campaigns.cpa.mode.get

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

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

{
	response: {
		url: %url%
                  }
}

Получение списка категорий по заданому фильтру

Для возврата списка категорий по заданому фильтру используется метод ads.campaigns.categories.get

Параметры Значение Дополнительные атрибуты
ad_format формат объявления:

ads.campaigns.foarmats.get

 обязательный параметр, int (числовое значение)
category_id id категории. ограничивает отображение только по id категории необязательный параметр, int (числовое значение)

Результат:
Возвращает массив ответов на запросы в массиве response. 

response: {
            count: %total%,
            items: [{
                       %category_id%: {
                            %region_id%: {
	                         min: %min_cost%,
	                         max: %max_cost%
                             }
                       }
                  },..]
}

Получение списка форматов объявлений

Для получения списка форматов объявлений используется метод ads.campaigns.formats.get

Результат:
Возвращает массив ответов на запросы в массиве response. 

response: {
       count: %total%,
       items: [{
             id: %format_id%,
             title: ‘%format title%’
       },..]
}

Получение списка платформ

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

Результат:
Возвращает массив ответов на запросы в массиве response. 

response: {
       count: %,
       items: [{
           id: %platform_id%,
           title: %platform_name%,
           mobile: %is mobile%
       },..]
}

Получение списка браузеров

Для получения списка браузеров используется метод ads.targeting.browsers.get

Результат:
Возвращает массив ответов на запросы в массиве response. 

response: {
       count: %,
       items: [{
           id: %browser_id%,
           title: %browser_name%,
       },..]
}

Источник — «https://wiki.kadam.net/index.php?title=Работа_с_ретаргетинговыми_кампаниями&oldid=2029»