CreateNewReport (Live)
Запускает на сервере формирование отчета о статистике кампании.
Метод отключен. Используйте API версии 5.
Информацию о соответствии методов в версиях Live 4 и 5 см. в Руководстве по переходу.
Метод возвращает идентификатор будущего отчета. По идентификатору можно узнать о готовности отчета и получить ссылку для скачивания файла с отчетом (метод GetReportList). Среднее время формирования отчета — одна-две минуты.
Ограничения
Для одной кампании возможно не более 300 вызовов метода CreateNewReport в сутки.
Для одного пользователя на сервере хранится не более пяти отчетов. При попытке сформировать шестой отчет возвращается сообщение об ошибке с кодом 31. Отчеты хранятся в течение пяти часов, а затем автоматически удаляются. С помощью метода DeleteReport можно удалить отчет вручную.
- Отчетный период
-
Отчетный период, заданный параметрами StartDate и EndDate, не должен превышать:
- 367 дней — для отчета с группировкой данных по объявлениям (clBanner), фразам (clPhrase), типу показа (clImage) и/или по дням;
- 31 день — для отчета с любой другой группировкой.
Если указан более длительный отчетный период, возвращается сообщение об ошибке с кодом 5.
Статистика доступна за последние три года от текущего месяца: например, 15 сентября 2016 года можно получить данные начиная с 1 сентября 2013 года.
- Цели и конверсии
-
Для получения данных о поведении посетителей на сайте (показатели goal_id, session_depth, goal_conversion, goal_cost, goal_conversions_num, revenue, roi) необходимо, чтобы на сайте рекламодателя был установлен счетчик Яндекс Метрики. Номер счетчика необходимо указать в параметре кампании AdditionalMetrikaCounters.
Для показателей goal_id, goal_conversion, goal_cost, goal_conversions_num, revenue, roi дополнительно требуется, чтобы для счетчика были настроены цели, для показателей revenue, roi — чтобы код счетчика передавал стоимость заказа.
- Средняя позиция
-
Данные по средней позиции объявления доступны начиная с 01.11.2014.
- Тип устройства
-
Данные по типу устройства доступны начиная с 01.11.2014.
- Пол и возрастная группа пользователя
-
Данные по полу и возрасту доступны начиная с 22.07.2015.
- Тип операционной системы и тип связи
-
Данные по типу операционной системы доступны начиная с 15.09.2015.
Данные по типу связи доступны начиная с 16.10.2015.
- Корректировка ставок
-
Данные по условию ретаргетинга, в соответствии с которым была применена корректировка ставок для посетивших сайт, доступны начиная с 22.07.2015.
Новое в версии Live 4
Входной параметр Currency стал обязательным для кампаний в реальной валюте.
Добавлены входные параметры Currency, IncludeVAT, IncludeDiscount.
В отчет добавлен показатель goal_conversions_num. Для входного параметра GroupByColumns добавлено значение clGoalConversionsNum.
В отчет добавлены показатели shows_average_position и clicks_average_position. Для входного параметра GroupByColumns добавлено значение clAveragePosition.
В отчет добавлен показатель device_type. Для входного параметра GroupByColumns добавлено значение clDeviceType.
В отчет добавлены показатели revenue и roi. Для входного параметра GroupByColumns добавлено значение clROI.
В отчет добавлены показатели age и gender. Для входного параметра GroupByColumns добавлено значение clDemographics. Добавлены входные параметры Age и Gender.
В отчет добавлены показатели mobile_platform и carrier_type. Для входного параметра GroupByColumns добавлены значения clMobilePlatform и clCarrierType. Добавлены входные параметры MobilePlatform и CarrierType.
Для кампаний с типом «Динамические текстовые объявления», если в параметре GroupByColumns задано значение clPhrase, отчет содержит данные об источнике для генерации динамических объявлений: записи с атрибутом WebpageID
.
В отчет добавлен показатель rl_adjustment_id. Для входного параметра GroupByColumns добавлено значение clAdjustment.
Для показателя stat_type добавлено значение Video.
Входные данные
Ниже показана структура входных данных в формате JSON.
{
"method": "CreateNewReport",
"param": {
/* NewReportInfo */
"CampaignID": (int),
"StartDate": (date),
"EndDate": (date),
"GroupByColumns": [
(string)
...
],
"Limit": (int),
"Offset": (int),
"GroupByDate": (string),
"OrderBy": [
(string)
...
],
"TypeResultReport": (string),
"CompressReport": (int),
"Filter": {
/* NewReportFilterInfo */
"PageType": (string),
"PositionType": (string),
"Banner": [
(long)
...
],
"Geo": [
(int)
...
],
"Phrase": [
(string)
...
],
"PageName": [
(string)
...
],
"StatGoals": [
(int)
...
],
"WithImage": (string),
"DeviceType": (string),
"Age": [
(string)
...
],
"Gender": [
(string)
...
],
"MobilePlatform": [
(string)
...
],
"CarrierType": [
(string)
...
]
},
"Currency": (string),
"IncludeVAT": (string),
"IncludeDiscount": (string)
}
}
Ниже приведено описание параметров.
Параметр | Описание | Требуется |
Объект NewReportInfo | ||
---|---|---|
CampaignID | Идентификатор кампании, для которой формируется отчет. | Да |
StartDate | Начальная дата отчетного периода, | Да |
EndDate | Конечная дата отчетного периода, | Да |
GroupByColumns | Названия показателей, выводимых в отчет дополнительно к статистическим данным. Возможные значения:
| Нет |
GroupByDate | Рассчитывать суммарную статистику по периодам времени:
Параметр имеет смысл указывать, если в массиве GroupByColumns указано значение clDate, в противном случае параметр игнорируется. | Нет |
OrderBy | Названия показателей, по которым сортируются записи в отчете. Возможные значения приведены в описании параметра GroupByColumns. | Нет |
Limit | Количество записей, отбираемых из базы данных в отчет (больше нуля). Параметры Limit и Offset служат для постраничной выборки записей. | Нет |
Offset | Номер записи, с которой начинается выборка (нумерация с нуля). Параметры Limit и Offset служат для постраничной выборки записей. | Если задан параметр Limit |
TypeResultReport | Формат отчета. В настоящее время используется только значение «xml». | Нет |
CompressReport | Метод сжатия отчета:
| Нет |
Filter | Объект NewReportFilterInfo с параметрами фильтрации записей для отчета. Если не задан, фильтрация не выполняется. | Нет |
Currency | Валюта, в которой должны быть выражены суммы в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245. Для кампаний в у. е. не указывайте параметр или передайте NULL. | Для кампаний в реальной валюте |
IncludeVAT | Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes. Если параметр Currency не задан, то параметр IncludeVAT игнорируется. | Нет |
IncludeDiscount | Учитывать скидку для стоимости кликов в валюте — Yes/No. При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes. Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если параметр Currency не задан, то используется значение No. | Нет |
Объект NewReportFilterInfo | ||
PageType | Отбирать записи по типам сайтов, на которых показаны объявления:
| Нет |
PositionType | Отбирать записи по блоку показа:
| Нет |
Banner | Массив идентификаторов объявлений. Отбираются записи о показе указанных объявлений. | Нет |
Geo | Массив идентификаторов регионов. Отбираются записи о показе объявлений в указанных регионах. | Нет |
Phrase | Массив строк. Отбираются записи о показе объявлений по тем ключевым фразам, которые содержат любую из указанных строк в качестве подстроки (без учета регистра символов). Примечание.
| Нет |
PageName | Массив названий сайтов. Отбираются записи о показе объявлений на указанных сайтах. Поисковый сайт Яндекса имеет название «Яндекс». Для других сайтов указываются домены, зарегистрированные в Яндекс Директе, например «mail.ru», «nigma.ru». | Нет |
StatGoals | Идентификатор цели Яндекс Метрики (указывается как элемент массива). Не допускается указывать более одного идентификатора. Если не задан, то показатели из Яндекс Метрики в отчете содержат агрегированные данные по всем целям. Список целей можно получить с помощью метода GetStatGoals (Live). | Нет |
WithImage | Отбирать записи о показах объявлений с изображениями или без. Возможные значения: yes — с изображениями, no — текстовые, both — все (текстовые, с изображениями и с видео). | Нет |
DeviceType | Отбирать записи о показах объявлений на конкретном типе устройств. Возможные значения: desktop/mobile/tablet. | Нет |
Age | Отбирать записи о показах объявлений пользователям указанных возрастных групп. В массиве могут присутствовать следующие значения: AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45, AGE_UNKNOWN. | Нет |
Gender | Отбирать записи о показах объявлений пользователям указанного пола. В массиве могут присутствовать следующие значения: GENDER_MALE, GENDER_FEMALE, GENDER_UNKNOWN. | Нет |
MobilePlatform | Отбирать записи о показах объявлений на устройствах с указанными типами операционных систем. В массиве могут присутствовать следующие значения: ANDROID, IOS, OS_TYPE_UNKNOWN. Фильтрация по типу операционной системы доступна только для кампаний с типом «Реклама мобильных приложений». | Нет |
CarrierType | Отбирать записи о показах объявлений по указанному типу связи. В массиве могут присутствовать следующие значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN. Фильтрация по типу связи доступна только для кампаний с типом «Реклама мобильных приложений». | Нет |
Параметр | Описание | Требуется |
Объект NewReportInfo | ||
---|---|---|
CampaignID | Идентификатор кампании, для которой формируется отчет. | Да |
StartDate | Начальная дата отчетного периода, | Да |
EndDate | Конечная дата отчетного периода, | Да |
GroupByColumns | Названия показателей, выводимых в отчет дополнительно к статистическим данным. Возможные значения:
| Нет |
GroupByDate | Рассчитывать суммарную статистику по периодам времени:
Параметр имеет смысл указывать, если в массиве GroupByColumns указано значение clDate, в противном случае параметр игнорируется. | Нет |
OrderBy | Названия показателей, по которым сортируются записи в отчете. Возможные значения приведены в описании параметра GroupByColumns. | Нет |
Limit | Количество записей, отбираемых из базы данных в отчет (больше нуля). Параметры Limit и Offset служат для постраничной выборки записей. | Нет |
Offset | Номер записи, с которой начинается выборка (нумерация с нуля). Параметры Limit и Offset служат для постраничной выборки записей. | Если задан параметр Limit |
TypeResultReport | Формат отчета. В настоящее время используется только значение «xml». | Нет |
CompressReport | Метод сжатия отчета:
| Нет |
Filter | Объект NewReportFilterInfo с параметрами фильтрации записей для отчета. Если не задан, фильтрация не выполняется. | Нет |
Currency | Валюта, в которой должны быть выражены суммы в ответе. Возможные значения: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. Значение должно совпадать с валютой кампании, в противном случае возвращается ошибка с кодом 245. Для кампаний в у. е. не указывайте параметр или передайте NULL. | Для кампаний в реальной валюте |
IncludeVAT | Учитывать НДС для стоимости кликов в валюте — Yes/No. При значении Yes суммы в отчете будут включать НДС. Если не задано, подразумевается Yes. Если параметр Currency не задан, то параметр IncludeVAT игнорируется. | Нет |
IncludeDiscount | Учитывать скидку для стоимости кликов в валюте — Yes/No. При значении Yes в отчете будут приведены суммы за вычетом скидки (то есть суммы, фактически списанные с баланса кампании). При значении No в отчете будут приведены суммы до применения скидки. Если не задано, подразумевается Yes. Примечание. Для кампаний, которые ведутся в валюте, скидка применяется в момент списания стоимости клика. Если параметр Currency не задан, то используется значение No. | Нет |
Объект NewReportFilterInfo | ||
PageType | Отбирать записи по типам сайтов, на которых показаны объявления:
| Нет |
PositionType | Отбирать записи по блоку показа:
| Нет |
Banner | Массив идентификаторов объявлений. Отбираются записи о показе указанных объявлений. | Нет |
Geo | Массив идентификаторов регионов. Отбираются записи о показе объявлений в указанных регионах. | Нет |
Phrase | Массив строк. Отбираются записи о показе объявлений по тем ключевым фразам, которые содержат любую из указанных строк в качестве подстроки (без учета регистра символов). Примечание.
| Нет |
PageName | Массив названий сайтов. Отбираются записи о показе объявлений на указанных сайтах. Поисковый сайт Яндекса имеет название «Яндекс». Для других сайтов указываются домены, зарегистрированные в Яндекс Директе, например «mail.ru», «nigma.ru». | Нет |
StatGoals | Идентификатор цели Яндекс Метрики (указывается как элемент массива). Не допускается указывать более одного идентификатора. Если не задан, то показатели из Яндекс Метрики в отчете содержат агрегированные данные по всем целям. Список целей можно получить с помощью метода GetStatGoals (Live). | Нет |
WithImage | Отбирать записи о показах объявлений с изображениями или без. Возможные значения: yes — с изображениями, no — текстовые, both — все (текстовые, с изображениями и с видео). | Нет |
DeviceType | Отбирать записи о показах объявлений на конкретном типе устройств. Возможные значения: desktop/mobile/tablet. | Нет |
Age | Отбирать записи о показах объявлений пользователям указанных возрастных групп. В массиве могут присутствовать следующие значения: AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45, AGE_UNKNOWN. | Нет |
Gender | Отбирать записи о показах объявлений пользователям указанного пола. В массиве могут присутствовать следующие значения: GENDER_MALE, GENDER_FEMALE, GENDER_UNKNOWN. | Нет |
MobilePlatform | Отбирать записи о показах объявлений на устройствах с указанными типами операционных систем. В массиве могут присутствовать следующие значения: ANDROID, IOS, OS_TYPE_UNKNOWN. Фильтрация по типу операционной системы доступна только для кампаний с типом «Реклама мобильных приложений». | Нет |
CarrierType | Отбирать записи о показах объявлений по указанному типу связи. В массиве могут присутствовать следующие значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN. Фильтрация по типу связи доступна только для кампаний с типом «Реклама мобильных приложений». | Нет |
Результирующие данные
Метод возвращает идентификатор будущего отчета, как показано в следующем примере.
{
"data": 137456
}
Примеры входных данных
Python
{
'CampaignID': 1327944,
'StartDate': '2013-05-01',
'EndDate': '2013-05-31',
'GroupByColumns': [
'clBanner',
'clStatGoals',
'clGoalConversionsNum',
'clAveragePosition',
'clROI'
],
'Filter': {
'PageType': 'search',
'PositionType': 'other',
'Banner': [1974642, 20920155, 20155899, 64654],
'Geo': [213],
'Phrase': [u'холодильник'],
'PageName': [u'Яндекс','nigma.ru'],
'StatGoals': [18565]
},
'Limit': 5000,
'Offset': 30000,
'GroupByDate': 'week',
'OrderBy': ['clBanner'],
'TypeResultReport': 'xml',
'CompressReport': 1
}
PHP
array(
'CampaignID' => 1327944,
'StartDate' => '2013-05-01',
'EndDate' => '2013-05-31',
'GroupByColumns' => array(
'clBanner',
'clStatGoals',
'clGoalConversionsNum',
'clAveragePosition',
'clROI'
),
'Filter' => array(
'PageType' => 'search',
'PositionType' => 'other',
'Banner' => array(1974642, 20920155, 20155899, 64654),
'Geo' => array(213),
'Phrase' => array('холодильник'),
'PageName' => array('Яндекс','nigma.ru'),
'StatGoals' => array(18565)
),
'Limit' => 5000,
'Offset' => 30000,
'GroupByDate' => 'week',
'OrderBy' => array('clBanner'),
'TypeResultReport' => 'xml',
'CompressReport' => 1
)
Perl
{
'CampaignID' => 1327944,
'StartDate' => '2013-05-01',
'EndDate' => '2013-05-31',
'GroupByColumns' => [
'clBanner',
'clStatGoals',
'clGoalConversionsNum',
'clAveragePosition',
'clROI'
],
'Filter' => {
'PageType' => 'search',
'PositionType' => 'other',
'Banner' => [1974642, 20920155, 20155899, 64654],
'Geo' => [213],
'Phrase' => ['холодильник'],
'PageName' => ['Яндекс','nigma.ru'],
'StatGoals' => [18565]
},
'Limit' => 5000,
'Offset' => 30000,
'GroupByDate' => 'week',
'OrderBy' => ['clBanner'],
'TypeResultReport' => 'xml',
'CompressReport' => 1
}
Пример отчета
Ниже показан пример отчета в формате XML.
<?xml version="1.0" encoding="UTF-8" ?>
<report>
<reportID>1234</reportID>
<campaignID>1234567</campaignID>
<startDate>2013-05-01</startDate>
<endDate>2013-05-31</endDate>
<phrasesDict>
<phrase type="phrase" phraseID="2" value="морозильное оборудование" />
<phrase type="retargeting" DictID="912" value="ретаргетинг: незавершенный заказ" />
<phrase type="webpage" WebpageID="258" value="планшеты" />
<phrase type="autotargeting" phraseID="11" value="---autotargeting (автотаргетинг)" />
</phrasesDict>
<stat>
<row bannerID="123456"
phraseID{stat}="2"
phrase_id="538205157"
statDate="2013-05-15"
sum_search="10"
sum_context="2"
shows_search="1000"
shows_context="123"
clicks_search="100"
clicks_context="23"
sum="12"
shows="1234"
clicks="123"
regionID="1"
placeName="Яндекс"
placeType="search"
goal_id="18565"
goal_conversion="25.91"
goal_cost="1.54"
session_depth="9.35"
goal_conversions_num="28"
revenue="245.25"
roi="3.77"
position_type="premium"
stat_type="Text"
shows_average_position="4.87"
clicks_average_position="4.95"
device_type="desktop"
age="AGE_25_34"
gender="GENDER_FEMALE"
mobile_platform="IOS"
carrier_type="STATIONARY"
rl_adjustment_id="14777"/>
<row bannerID="123457"
DictID{stat}="912"
RetargetingID="3097"
statDate="2013-05-25"
sum_search="0"
sum_context="96.35"
shows_search="0"
shows_context="755"
clicks_search="0"
clicks_context="57"
sum="96.35"
shows="755"
clicks="57"
regionID="1"
placeName="catalog.tut.by"
placeType="context"
goal_id="18565"
goal_conversion="28.88"
revenue="132.01"
roi="3.12"
goal_cost="1.54"
session_depth="9.39"
goal_conversions_num="11"
position_type="other"
stat_type="Image"
device_type="mobile"
age="AGE_UNKNOWN"
gender="GENDER_UNKNOWN"
mobile_platform="ANDROID"
carrier_type="CELLULAR"/>
</stat>
</report>
Ниже приведено описание показателей, выдаваемых в отчете.
Элемент/атрибут | Описание | Условие вывода |
Элемент report | ||
---|---|---|
reportID | Идентификатор отчета. | |
campaignID | Идентификатор кампании. | |
startDate | Начальная дата отчетного периода, YYYY-MM-DD . | |
endDate | Конечная дата отчетного периода, YYYY-MM-DD . | |
phrasesDict | Словарь фраз. Содержит информацию об объектах в отчете: фразах, рубриках Яндекс Каталога, ретаргетингах, условиях нацеливания для динамических текстовых объявлений. | |
stat | Статистические данные. | |
Элемент phrasesDict | ||
phrase | Информация о фразе, рубрике, ретаргетинге или условии нацеливания в атрибутах type, phraseID, DictID, WebpageID и value. | |
type | Содержит значение «phrase» в записях о фразах, или значение «autotargeting» в записях об автотаргетингах, или «rubric» в записях о рубриках Яндекс Каталога, или «retargeting» в записях о ретаргетингах, или «webpage» в записях об источнике для генерации динамических объявлений. | |
phraseID | Идентификатор фразы в отчете. 1 — для дополнительных релевантных фраз. 11 — для автотаргетингов. Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row. | |
rubricID | Идентификатор рубрики в отчете. Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | |
DictID | Идентификатор ретаргетинга в отчете. Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | |
WebpageID | Идентификатор источника данных для генерации динамических объявлений:
| |
value | Текст фразы, или номер рубрики Яндекс Каталога, или название условия ретаргетинга, или название интереса к категории мобильных приложений, или название условия нацеливания для динамических объявлений, или название фильтра, или значение «Автоматически добавленные фразы» (для дополнительных релевантных фраз). | |
Элемент stat | ||
row | Запись статистики. Содержание записи зависит от входных параметров. | |
sum | Стоимость кликов, списанная с баланса кампании (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | |
shows | Количество показов 1 . | |
clicks | Количество кликов 1 . | |
bannerID | Идентификатор объявления. | Во входном параметре GroupByColumns указано значение «clBanner» или «clImage». |
phraseID | Идентификатор фразы в отчете (см. элемент phrasesDict). Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о фразе или рубрике Яндекс Каталога (но не о ретаргетинге). |
phrase_id | Идентификатор фразы, автотаргетинга или рубрики в Директе. Идентификатор может не существовать в Директе на момент формирования отчета. Это связано с тем, что идентификаторы меняются при редактировании фраз или удаляются вместе с фразами. | Во входном параметре GroupByColumns одновременно указаны значения «clBanner» и «clPhrase», и запись содержит информацию о фразе или рубрике Яндекс Каталога (но не о ретаргетинге). Внимание. Данный показатель выводится в отчет начиная с версии Live 4. |
rubricID | Идентификатор рубрики Яндекс Каталога в отчете (см. элемент phrasesDict). Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о рубрике Яндекс Каталога. |
DictID | Идентификатор ретаргетинга в отчете (см. элемент phrasesDict). Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о ретаргетинге. |
WebpageID | Идентификатор источника данных для генерации динамических объявлений:
| Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию об источнике данных для генерации динамических объявлений. |
RetargetingID | Идентификатор ретаргетинга в Директе. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о ретаргетинге. |
statDate | Дата, за которую приведена статистика. Если входной параметр GroupByDate имеет значение «week» или «month», указывается первая дата недели или месяца соответственно. | В массиве GroupByColumns присутствует значение «clDate». |
sum_search | Стоимость кликов на поиске (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | Входной параметр PageType не задан или имеет значение «all». |
sum_context | Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | |
shows_search | Количество показов на поиске. | |
shows_context | Количество показов в Рекламной сети Яндекса. | |
clicks_search | Количество кликов на поиске. | |
clicks_context | Количество кликов в Рекламной сети Яндекса. | |
regionID | Идентификатор региона показов. | В массиве GroupByColumns присутствует значение «clGeo». |
placeName | Название площадки показов. | В массиве GroupByColumns присутствует значение «clPage». |
placeType | Тип площадки показов: «search» — поисковая площадка (включая поиск Яндекса и поисковые площадки в Рекламной сети Яндекса), «context» — сайт в Рекламной сети Яндекса. | |
goal_id | Идентификатор цели в Яндекс Метрике, если он был передан во входном параметре StatGoals. 0 — если идентификатор не был передан. В этом случае остальные показатели из Яндекс Метрики содержат агрегированные данные по всем целям. | В массиве GroupByColumns присутствует значение «clStatGoals». |
goal_conversion | Доля целевых визитов в общем числе визитов, в процентах. | |
goal_cost | Средняя цена целевого визита: отношение стоимости кликов к количеству целевых визитов. | |
session_depth | Глубина просмотра сайта. | |
goal_conversions_num | Количество целевых визитов (конверсий). | В массиве GroupByColumns присутствует значение «clGoalConversionsNum». |
revenue | Доход (до двух знаков после запятой) — сумма показателей стоимости заказа, переданных счетчиком Яндекс Метрики. | В массиве GroupByColumns присутствует значение «clROI». |
roi | Рентабельность инвестиций в рекламу (до двух знаков после запятой): | |
position_type | Блок показа объявления: «premium» — спецразмещение, «other» — другие блоки. | В массиве GroupByColumns присутствует значение «clPositionType». |
stat_type | Формат показа объявления. Возможные значения: Text (текстовый), Image (с изображением), Video (с видео). | В массиве GroupByColumns присутствует значение «clImage». |
shows_average_position | Средняя позиция показа объявления. При расчете учитываются только показы на первой странице результатов поиска Яндекса. Наивысшая позиция имеет номер 1. | В массиве GroupByColumns присутствует значение «clAveragePosition». |
clicks_average_position | Средняя позиция, на которой произошел клик по объявлению. При расчете учитываются только клики на первой странице результатов поиска Яндекса. | |
device_type | Тип устройства, на котором было показано объявление. Возможные значения: desktop/mobile/tablet. | В массиве GroupByColumns присутствует значение «clDeviceType». |
age | Возрастная группа пользователя. Возможные значения: AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45, AGE_UNKNOWN. | В массиве GroupByColumns присутствует значение «clDemographics». |
gender | Пол пользователя. Возможные значения: GENDER_MALE, GENDER_FEMALE, GENDER_UNKNOWN. | В массиве GroupByColumns присутствует значение «clDemographics». |
mobile_platform | Тип операционной системы. Возможные значения: ANDROID, IOS, OS_TYPE_UNKNOWN. | Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clMobilePlatform». |
carrier_type | Тип связи. Возможные значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN. | Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clCarrierType». |
rl_adjustment_id | Идентификатор условия ретаргетинга, в соответствии с которым применена корректировка ставок для посетивших сайт. | Тип кампании — «Текстово-графические объявления» или «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clAdjustment». |
Примечания | ||
|
Элемент/атрибут | Описание | Условие вывода |
Элемент report | ||
---|---|---|
reportID | Идентификатор отчета. | |
campaignID | Идентификатор кампании. | |
startDate | Начальная дата отчетного периода, YYYY-MM-DD . | |
endDate | Конечная дата отчетного периода, YYYY-MM-DD . | |
phrasesDict | Словарь фраз. Содержит информацию об объектах в отчете: фразах, рубриках Яндекс Каталога, ретаргетингах, условиях нацеливания для динамических текстовых объявлений. | |
stat | Статистические данные. | |
Элемент phrasesDict | ||
phrase | Информация о фразе, рубрике, ретаргетинге или условии нацеливания в атрибутах type, phraseID, DictID, WebpageID и value. | |
type | Содержит значение «phrase» в записях о фразах, или значение «autotargeting» в записях об автотаргетингах, или «rubric» в записях о рубриках Яндекс Каталога, или «retargeting» в записях о ретаргетингах, или «webpage» в записях об источнике для генерации динамических объявлений. | |
phraseID | Идентификатор фразы в отчете. 1 — для дополнительных релевантных фраз. 11 — для автотаргетингов. Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row. | |
rubricID | Идентификатор рубрики в отчете. Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | |
DictID | Идентификатор ретаргетинга в отчете. Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | |
WebpageID | Идентификатор источника данных для генерации динамических объявлений:
| |
value | Текст фразы, или номер рубрики Яндекс Каталога, или название условия ретаргетинга, или название интереса к категории мобильных приложений, или название условия нацеливания для динамических объявлений, или название фильтра, или значение «Автоматически добавленные фразы» (для дополнительных релевантных фраз). | |
Элемент stat | ||
row | Запись статистики. Содержание записи зависит от входных параметров. | |
sum | Стоимость кликов, списанная с баланса кампании (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | |
shows | Количество показов 1 . | |
clicks | Количество кликов 1 . | |
bannerID | Идентификатор объявления. | Во входном параметре GroupByColumns указано значение «clBanner» или «clImage». |
phraseID | Идентификатор фразы в отчете (см. элемент phrasesDict). Идентификатор phraseID существует только внутри отчета и не совпадает с идентификатором фразы в Директе. Он служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о фразе или рубрике Яндекс Каталога (но не о ретаргетинге). |
phrase_id | Идентификатор фразы, автотаргетинга или рубрики в Директе. Идентификатор может не существовать в Директе на момент формирования отчета. Это связано с тем, что идентификаторы меняются при редактировании фраз или удаляются вместе с фразами. | Во входном параметре GroupByColumns одновременно указаны значения «clBanner» и «clPhrase», и запись содержит информацию о фразе или рубрике Яндекс Каталога (но не о ретаргетинге). Внимание. Данный показатель выводится в отчет начиная с версии Live 4. |
rubricID | Идентификатор рубрики Яндекс Каталога в отчете (см. элемент phrasesDict). Существует только внутри отчета и не совпадает с идентификатором рубрики в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о рубрике Яндекс Каталога. |
DictID | Идентификатор ретаргетинга в отчете (см. элемент phrasesDict). Существует только внутри отчета и не совпадает с идентификатором ретаргетинга в Директе. Служит для нормализации данных в отчете и связывает элементы phrase и row. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о ретаргетинге. |
WebpageID | Идентификатор источника данных для генерации динамических объявлений:
| Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию об источнике данных для генерации динамических объявлений. |
RetargetingID | Идентификатор ретаргетинга в Директе. | Во входном параметре GroupByColumns указано значение «clPhrase», и запись содержит информацию о ретаргетинге. |
statDate | Дата, за которую приведена статистика. Если входной параметр GroupByDate имеет значение «week» или «month», указывается первая дата недели или месяца соответственно. | В массиве GroupByColumns присутствует значение «clDate». |
sum_search | Стоимость кликов на поиске (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | Входной параметр PageType не задан или имеет значение «all». |
sum_context | Стоимость кликов в Рекламной сети Яндекса (в валюте, указанной во входном параметре Currency). См. Примечания ниже. | |
shows_search | Количество показов на поиске. | |
shows_context | Количество показов в Рекламной сети Яндекса. | |
clicks_search | Количество кликов на поиске. | |
clicks_context | Количество кликов в Рекламной сети Яндекса. | |
regionID | Идентификатор региона показов. | В массиве GroupByColumns присутствует значение «clGeo». |
placeName | Название площадки показов. | В массиве GroupByColumns присутствует значение «clPage». |
placeType | Тип площадки показов: «search» — поисковая площадка (включая поиск Яндекса и поисковые площадки в Рекламной сети Яндекса), «context» — сайт в Рекламной сети Яндекса. | |
goal_id | Идентификатор цели в Яндекс Метрике, если он был передан во входном параметре StatGoals. 0 — если идентификатор не был передан. В этом случае остальные показатели из Яндекс Метрики содержат агрегированные данные по всем целям. | В массиве GroupByColumns присутствует значение «clStatGoals». |
goal_conversion | Доля целевых визитов в общем числе визитов, в процентах. | |
goal_cost | Средняя цена целевого визита: отношение стоимости кликов к количеству целевых визитов. | |
session_depth | Глубина просмотра сайта. | |
goal_conversions_num | Количество целевых визитов (конверсий). | В массиве GroupByColumns присутствует значение «clGoalConversionsNum». |
revenue | Доход (до двух знаков после запятой) — сумма показателей стоимости заказа, переданных счетчиком Яндекс Метрики. | В массиве GroupByColumns присутствует значение «clROI». |
roi | Рентабельность инвестиций в рекламу (до двух знаков после запятой): | |
position_type | Блок показа объявления: «premium» — спецразмещение, «other» — другие блоки. | В массиве GroupByColumns присутствует значение «clPositionType». |
stat_type | Формат показа объявления. Возможные значения: Text (текстовый), Image (с изображением), Video (с видео). | В массиве GroupByColumns присутствует значение «clImage». |
shows_average_position | Средняя позиция показа объявления. При расчете учитываются только показы на первой странице результатов поиска Яндекса. Наивысшая позиция имеет номер 1. | В массиве GroupByColumns присутствует значение «clAveragePosition». |
clicks_average_position | Средняя позиция, на которой произошел клик по объявлению. При расчете учитываются только клики на первой странице результатов поиска Яндекса. | |
device_type | Тип устройства, на котором было показано объявление. Возможные значения: desktop/mobile/tablet. | В массиве GroupByColumns присутствует значение «clDeviceType». |
age | Возрастная группа пользователя. Возможные значения: AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45, AGE_UNKNOWN. | В массиве GroupByColumns присутствует значение «clDemographics». |
gender | Пол пользователя. Возможные значения: GENDER_MALE, GENDER_FEMALE, GENDER_UNKNOWN. | В массиве GroupByColumns присутствует значение «clDemographics». |
mobile_platform | Тип операционной системы. Возможные значения: ANDROID, IOS, OS_TYPE_UNKNOWN. | Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clMobilePlatform». |
carrier_type | Тип связи. Возможные значения: CELLULAR (мобильная связь), STATIONARY (wi-fi), CARRIER_TYPE_UNKNOWN. | Тип кампании — «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clCarrierType». |
rl_adjustment_id | Идентификатор условия ретаргетинга, в соответствии с которым применена корректировка ставок для посетивших сайт. | Тип кампании — «Текстово-графические объявления» или «Реклама мобильных приложений», и в массиве GroupByColumns присутствует значение «clAdjustment». |
Примечания | ||
|