CreateNewReport

Идентификатор кампании, для которой формируется отчет.

Начальная дата отчетного периода, YYYY-MM-DD.

Конечная дата отчетного периода, YYYY-MM-DD.

Названия показателей, выводимых в отчет дополнительно к статистическим данным. Возможные значения:

• clBanner — идентификатор объявления bannerID;
• clDate — дата сбора статистики statDate;
• clPage — данные о площадке показов: placeName, placeType;
• clGeo — идентификатор региона показов regionID;
• clPhrase — идентификатор фразы phraseID, или идентификатор рубрики Яндекс Каталога rubricID, или идентификатор ретаргетинга DictID, или идентификатор источника данных для генерации динамических объявлений WebpageID;
• clStatGoals — данные Яндекс Метрики: goal_id, session_depth, goal_conversion, goal_cost (см. Цели и конверсии);
• clGoalConversionsNum — данные Яндекс Метрики: количество целевых визитов goal_conversions_num (см. Цели и конверсии). Рекомендуется указывать данное значение вместе с clStatGoals;
• clPositionType — позиция показа position_type;
• clImage — формат показа объявления stat_type, а также идентификатор объявления bannerID (значение clBanner автоматически добавляется к входным данным);
• clAveragePosition — средняя позиция показов объявления shows_average_position и средняя позиция кликов по объявлению clicks_average_position. Чтобы получить эти показатели для каждого объявления в отдельности, следует указывать значение clAveragePosition вместе с clBanner;
• clDeviceType — тип устройства, на котором показано объявление;
• clROI — доход revenue и рентабельность roi (см. Цели и конверсии);
• clDemographics — возрастная группа age и пол gender пользователя;
• clMobilePlatform — тип операционной системы mobile_plaform (показатель доступен только для кампаний с типом «Реклама мобильных приложений»);
• clCarrierType — тип связи carrier_type (показатель доступен только для кампаний с типом «Реклама мобильных приложений»);
• clAdjustment — идентификатор условия ретаргетинга rl_adjustment_id, в соответствии с которым применена корректировка ставок (показатель доступен только для кампаний с типом «Текстово-графические объявления» или «Реклама мобильных приложений»).

Рассчитывать суммарную статистику по периодам времени:

• day — по дням (исходное значение);
• week — по неделям;
• month — по месяцам.

Параметр имеет смысл указывать, если в массиве GroupByColumns указано значение clDate, в противном случае параметр игнорируется.

Названия показателей, по которым сортируются записи в отчете. Возможные значения приведены в описании параметра GroupByColumns.

Количество записей, отбираемых из базы данных в отчет (больше нуля).

Номер записи, с которой начинается выборка (нумерация с нуля).

Параметры Limit и Offset служат для постраничной выборки записей.

Метод сжатия отчета:

• 0 или отсутствие параметра — не сжимать;
• 1 — сжимать методом gzip.

Отбирать записи по типам сайтов, на которых показаны объявления:

• search — на поиске Яндекса и на поисковых площадках в Рекламной сети Яндекса;
• context — на сайтах в Рекламной сети Яндекса, кроме поисковых площадок;
• all или отсутствие параметра — на всех типах сайтов.

Отбирать записи по блоку показа:

• premium — в спецразмещении;
• other — везде, кроме спецразмещения.

Массив строк. Отбираются записи о показе объявлений по тем ключевым фразам, которые содержат любую из указанных строк в качестве подстроки (без учета регистра символов).

Массив названий сайтов. Отбираются записи о показе объявлений на указанных сайтах.

Поисковый сайт Яндекса имеет название «Яндекс». Для других сайтов указываются домены, зарегистрированные в Яндекс Директе, например «mail.ru», «nigma.ru».

Идентификатор цели Яндекс Метрики (указывается как элемент массива). Не допускается указывать более одного идентификатора.

Если не задан, то показатели из Яндекс Метрики в отчете содержат агрегированные данные по всем целям.

Список целей можно получить с помощью метода GetStatGoals (Live).

Отбирать записи о показах объявлений на конкретном типе устройств. Возможные значения: desktop/mobile/tablet.

Отбирать записи о показах объявлений на устройствах с указанными типами операционных систем. В массиве могут присутствовать следующие значения: ANDROID, IOS, OS_TYPE_UNKNOWN.

Фильтрация по типу операционной системы доступна только для кампаний с типом «Реклама мобильных приложений».

Отбирать записи о показах объявлений по указанному типу связи. В массиве могут присутствовать следующие значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN.

Фильтрация по типу связи доступна только для кампаний с типом «Реклама мобильных приложений».

Идентификатор фразы в отчете.

Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row.

Идентификатор рубрики в отчете.

Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row.

Идентификатор ретаргетинга в отчете.

Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row.

Стоимость кликов, списанная с баланса кампании ¹ .

Идентификатор фразы в отчете (см. элемент phrasesDict).

Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row.

Во входном параметре GroupByColumns указано значение «clPhrase» и запись содержит информацию о фразе (не о рубрике и не о ретаргетинге).

Идентификатор рубрики Яндекс Каталога в отчете (см. элемент phrasesDict).

Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row.

Во входном параметре GroupByColumns указано значение «clPhrase» и запись содержит информацию о рубрике Яндекс Каталога.

Идентификатор ретаргетинга в отчете (см. элемент phrasesDict).

Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row.

Во входном параметре GroupByColumns указано значение «clPhrase» и запись содержит информацию о ретаргетинге.

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

Стоимость кликов в Рекламной сети Яндекса.

Количество показов на поиске.

Идентификатор цели в Яндекс Метрике, если он был передан во входном параметре StatGoals.

0 — если идентификатор не был передан. В этом случае остальные показатели из Яндекс Метрики содержат агрегированные данные по всем целям.

В массиве GroupByColumns присутствует значение «clStatGoals».

Количество целевых визитов (конверсий).

В массиве GroupByColumns присутствует значение «clGoalConversionsNum».

Блок показа объявления: «premium» — спецразмещение, «other» — другие блоки.

Средняя позиция показа объявления. При расчете учитываются только показы на первой странице результатов поиска Яндекса.

Наивысшая позиция имеет номер 1.

1. Значения параметров sum, shows, clicks зависят от входного параметра PageType:

   • при значении «all» или отсутствии PageType приводятся суммарные данные по поиску и Рекламной сети Яндекса. При этом данные отдельно по поиску и отдельно по Рекламной сети приводятся в параметрах sum_search, shows_search, clicks_search, sum_context, shows_context, clicks_context);
   • при значении «search» приводятся данные по поиску и поисковым площадкам в Рекламной сети Яндекса;
   • при значении «context» приводятся данные по сайтам в Рекламной сети Яндекса, кроме поисковых площадок.