← К справке Документация API

Яндекс Директ

Каталог полей Reports API

UnderscoreStat · 0.7.053

Справочник составлен по адаптеру и каталогу UnderscoreStat. Набор полей в конкретном ответе зависит от запроса, настроек и прав доступа.

Записей в справочнике — 89

Методы, параметры и ответ

ПолеОписание
POST /json/v501/reportsАдрес отчётного API, используемый UnderscoreStat.
params.FieldNamesСтолбцы отчёта. Совместимость зависит от типа отчёта.
params.ReportTypeТип отчёта.
params.SelectionCriteriaУсловия отбора строк.
params.DateRangeTypeТип периода, включая CUSTOM_DATE.
params.FormatФормат выгрузки TSV.
params.IncludeVATОпределяет включение НДС в денежные показатели.

Каталог полей UnderscoreStat

ПолеОписание
AdFormatФормат объявления Недоступно для — CRITERIA_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
AdGroupIdID группы объявлений Обязательно для — ADGROUP_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT. Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT.
AdGroupNameНазвание группы объявлений Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT.
AdIdID объявления Обязательно для — AD_PERFORMANCE_REPORT. Недоступно для — CRITERIA_PERFORMANCE_REPORT, ACCOUNT_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT.
AdNetworkTypeТип рекламной сети Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
AgeВозраст Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
AudienceTargetIdID аудитории таргетинга Недоступно для — AD_PERFORMANCE_REPORT, ACCOUNT_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT. Несовместимо с — CriterionType, CriteriaType, DynamicTextAdTargetId, Keyword, SmartAdTargetId.
AvgClickPositionСредняя позиция клика Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
AvgCpcСредняя цена за клик
AvgCpmСредняя цена за тысячу показов Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
AvgEffectiveBidСредняя эффективная ставка
AvgImpressionFrequencyСредняя частота показов Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
AvgImpressionPositionСредняя позиция показов Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — ClickType.
AvgPageviewsСреднее количество просмотренных страниц
AvgTrafficVolumeСредний объем трафика Несовместимо с — ClickType.
AvgVideoCompleteCostСредняя стоимость полного просмотра видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
BounceRateПоказатель отказов
BouncesКоличество отказов
CampaignIdID кампании Обязательно для — CAMPAIGN_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Недоступно для — ACCOUNT_PERFORMANCE_REPORT.
CampaignNameНазвание кампании Недоступно для — ACCOUNT_PERFORMANCE_REPORT.
CampaignUrlPathURL-путь кампании Недоступно для — ACCOUNT_PERFORMANCE_REPORT.
CampaignTypeТип кампании
CarrierTypeТип оператора Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
ClicksКлики
ClickTypeТип клика Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT. Несовместимо с — Impressions, Ctr, AvgImpressionPosition, WeightedImpressions, WeightedCtr, AvgTrafficVolume.
ClientLoginЛогин клиента
ConversionRateКонверсия
ConversionsКонверсии
CostСтоимость
CostPerConversionСтоимость за конверсию
CPVСтоимость за просмотр (Cost Per View) Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
CriteriaКритерии Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criterion, CriterionId, CriterionType.
CriteriaIdID критериев Обязательно для — CRITERIA_PERFORMANCE_REPORT. Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criterion, CriterionId, CriterionType.
CriteriaTypeТип критериев Обязательно для — CRITERIA_PERFORMANCE_REPORT. Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criterion, CriterionId, CriterionType.
CriterionКритерий Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criteria, CriteriaId, CriteriaType.
CriterionIdID критерия Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criteria, CriteriaId, CriteriaType.
CriterionTypeТип критерия Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT. Несовместимо с — Criteria, CriteriaId, CriteriaType, AudienceTargetId, DynamicTextAdTargetId, Keyword, SmartAdTargetId.
CtrКликабельность (CTR) Несовместимо с — ClickType.
DateДата Несовместимо с — Week, Month, Quarter, Year.
DeviceУстройство Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
DynamicTextAdTargetIdID динамического текстового объявления Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT. Несовместимо с — CriterionType, CriteriaType, AudienceTargetId, Keyword, SmartAdTargetId.
ExternalNetworkNameНазвание внешней сети Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
GenderПол Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
GoalsRoiROI целей
ImpressionReachОхват показов Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
ImpressionsПоказы Несовместимо с — ClickType.
IncomeGradeУровень дохода Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
KeywordКлючевое слово Недоступно для — ACCOUNT_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT, CUSTOM_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT. Несовместимо с — CriterionType, CriteriaType, AudienceTargetId, DynamicTextAdTargetId, SmartAdTargetId.
LocationOfPresenceIdID местоположения присутствия Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
LocationOfPresenceNameНазвание местоположения присутствия Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
MatchedKeywordСовпадающее ключевое слово Недоступно для — ACCOUNT_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, CUSTOM_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
MatchTypeТип соответствия Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
MobilePlatformМобильная платформа Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
MonthМесяц Несовместимо с — Date, Week, Quarter, Year.
PlacementРазмещение Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
ProfitПрибыль
PurchaseRevenueДоход только с целей покупок
PurchaseProfitПрибыль с целей покупок
QuarterКвартал Несовместимо с — Date, Week, Month, Year.
QueryПоисковый запрос Обязательно для — SEARCH_QUERY_PERFORMANCE_REPORT. Недоступно для — ACCOUNT_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, CUSTOM_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
RevenueДоход
RlAdjustmentIdID корректировки RL Недоступно для — ACCOUNT_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
SessionsСеансы Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
SlotСлот Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT.
SmartAdTargetIdID целевой рекламы Smart Недоступно для — ACCOUNT_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, REACH_AND_FREQUENCY_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT. Несовместимо с — CriterionType, CriteriaType, AudienceTargetId, DynamicTextAdTargetId, Keyword.
TargetingCategoryКатегория таргетинга Недоступно для — REACH_AND_FREQUENCY_PERFORMANCE_REPORT.
TargetingLocationIdID местоположения таргетинга Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
TargetingLocationNameНазвание местоположения таргетинга Недоступно для — SEARCH_QUERY_PERFORMANCE_REPORT.
VideoCompleteПолные просмотры видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoCompleteRateПроцент полных просмотров видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoFirstQuartileПросмотры первой четверти видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoFirstQuartileRateПроцент просмотров первой четверти видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoMidpointПросмотры середины видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoMidpointRateПроцент просмотров середины видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoThirdQuartileПросмотры третьей четверти видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoThirdQuartileRateПроцент просмотров третьей четверти видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoViewsПросмотры видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
VideoViewsRateПроцент просмотров видео Недоступно для — ACCOUNT_PERFORMANCE_REPORT, CAMPAIGN_PERFORMANCE_REPORT, ADGROUP_PERFORMANCE_REPORT, AD_PERFORMANCE_REPORT, CRITERIA_PERFORMANCE_REPORT, SEARCH_QUERY_PERFORMANCE_REPORT, CUSTOM_REPORT.
WeekНеделя Несовместимо с — Date, Month, Quarter, Year.
WeightedCtrВзвешенный CTR Несовместимо с — ClickType.
WeightedImpressionsВзвешенные показы Несовместимо с — ClickType.
YearГод Несовместимо с — Date, Week, Month, Quarter.