CreateNewReport (Live)

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

Начальная дата отчетного периода, 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.

Валюта, в которой должны быть выражены суммы в ответе.

Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245.

Для кампаний в у. е. не указывайте параметр или передайте NULL.

Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes.

Если параметр Currency не задан, то параметр IncludeVAT игнорируется.

Учитывать скидку для стоимости кликов в валюте — Yes/No.

При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes.

Если параметр Currency не задан, то используется значение No.

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

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

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

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

1 — для дополнительных релевантных фраз.

11 — для автотаргетингов.

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

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

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

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

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

Текст фразы, или номер рубрики Яндекс Каталога, или название условия ретаргетинга, или название интереса к категории мобильных приложений, или название условия нацеливания для динамических объявлений, или название фильтра, или значение «Автоматически добавленные фразы» (для дополнительных релевантных фраз).

Стоимость кликов, списанная с баланса кампании (в валюте, указанной во входном параметре Currency).

См. Примечания ниже.

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

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

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

Идентификатор фразы, автотаргетинга или рубрики в Директе.

Идентификатор может не существовать в Директе на момент формирования отчета. Это связано с тем, что идентификаторы меняются при редактировании фраз или удаляются вместе с фразами.

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

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

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

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

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

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

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

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

Стоимость кликов на поиске (в валюте, указанной во входном параметре Currency).

См. Примечания ниже.

Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре Currency).

См. Примечания ниже.

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

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

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

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

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

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

Рентабельность инвестиций в рекламу (до двух знаков после запятой):

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

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

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

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

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

Возрастная группа пользователя. Возможные значения: AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45, AGE_UNKNOWN.

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

Пол пользователя. Возможные значения: GENDER_MALE, GENDER_FEMALE, GENDER_UNKNOWN.

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

Тип операционной системы. Возможные значения: ANDROID, IOS, OS_TYPE_UNKNOWN.

Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clMobilePlatform».

Тип связи. Возможные значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN.

Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clCarrierType».

Идентификатор условия ретаргетинга, в соответствии с которым применена корректировка ставок для посетивших сайт.

Тип кампании — «Текстово-графические объявления» или «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clAdjustment».

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

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

   Стоимость кликов с учетом НДС = Стоимость кликов без учета НДС × (1 + Ставка НДС)

3. Стоимость кликов, выраженная в валюте, может учитывать или не учитывать скидку в зависимости от значения входного параметра IncludeDiscount.

   Стоимость кликов до применения скидки = Стоимость кликов, фактически списанная с баланса / (1 – Cкидка)

   Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика.
4. Если кампания велась в у. е., суммы возвращаются «как есть», без каких-либо преобразований.