Reporting Service 模型
报告服务包含用于提交报表请求和轮询其状态的操作。 这些报表提供有关 Microsoft Advertising 帐户、市场活动和广告组的详细统计信息。 这些信息可帮助你跟踪财务情况、衡量广告性能并调整设置以优化预算或市场活动。 例如,可以使用关键字 (keyword) 性能报告来查看哪些关键字表现良好,哪些关键字表现不佳。
Reporting Service 概述
提交报表请求时,选择 “报表属性”和“性能统计信息 ”以确定报表的内容。 例如,你可能希望包含展示次数、点击率和点击率。 报表使用列名称作为列标题。 报表包含列的顺序与在报表请求的 Columns 元素中包含列的顺序相同。 有关列如何影响数据输出的信息,请参阅下面的对 数据进行分组的列 。 有关同一报表请求中列组合的限制的信息,请参阅下面的 列限制 。
您还将指定用于限制返回数据集的报表参数。 例如,可以设置聚合级别以按天或月对数据进行分组;使用特定日期或预定义的日期范围(例如今天或过去七天)指定要包含在报表中的数据的时间段;通过标识要包含在报表中的帐户、市场活动和广告组来指定数据范围;并设置筛选条件以筛选报表数据。 有关可为每个聚合值指定的时间段的信息,请参阅下面的 聚合和时间 。
有关可请求的报表列表,请参阅 报表类型。 有关可设置的报表参数的完整列表,请参阅每个报表请求对象和 ReportRequest 基对象。
有关如何请求和下载报表的信息,请参阅 请求和下载报表当报表成功完成时,可以从服务返回的 URL 下载报表。 报表文件已压缩,因此必须解压缩文件才能读取报表。 系统可以存储的报表数量没有限制:但是,未定义存储报表的时间长度。 对于重复的报表请求,该服务不会检查。
有关时区如何影响报表可用性的信息,请参阅下面的 报告中的时区 。
报表文件架构
可以请求 Csv、Tsv 或 Xml 报表数据。 默认情况下,如果不选择其他 格式 ,则下载的数据以逗号分隔 (Csv) 。
"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 10:15:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 10:15:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 5"
"AccountId","CampaignId","Keyword","KeywordId","DeviceType","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","Computer","35"
"YourAccountId","YourCampaignId","red shoes","123","Smartphone","50"
"YourAccountId","YourCampaignId","shoes delivered","234","Computer","1"
"YourAccountId","YourCampaignId","shoe sale","345","Computer","80"
"YourAccountId","YourCampaignId","shoe sale","345","Smartphone","5"
"@2020 Microsoft Corporation. All rights reserved. "
默认情况下包含以下报表标头元数据。 如果不希望标头元数据将 ExcludeReportHeader 设置为 true。
标头元数据 | 说明 |
---|---|
报表名称 | 提交报表时选择的 ReportName 。 |
报告时间 | 在提交报表时选择的报告时间。 如果请求了多天,开始日期和结束日期将用逗号分隔,例如“报告时间:2/1/2020,2/7/2020”。 |
时区 | 指示使用哪个时区来确定请求的报告时间最后一天的结束时间。 有关时区如何影响报表可用性的信息,请参阅下面的 报告中的时区 。 |
最后完成的可用日期 | Microsoft Advertising 完成此报表类型的数据处理的最近日期和时间。 时间始终相对于 UTC 报告,因此请忽略报告中写入 (GMT) 后缀。 |
上次完成的可用小时数 | Microsoft Advertising 完成此报表类型的数据处理的最近日期和时间。 时间始终相对于 UTC 报告,因此请忽略报告中写入 (GMT) 后缀。 |
报表聚合 | 反映报表请求中设置的聚合类型。 有关信息,请参阅下面的 聚合和时间 。 |
报表筛选器 | 保留供以后使用。 |
潜在的不完整数据 | 如果设置为 true ,则可能无法在请求报表时间的最后一天完全处理报表数据。 ReturnOnlyCompleteData 请求元素确定服务是否必须确保所有数据都已处理且可用。 有关时区如何影响报表可用性的信息,请参阅下面的 报告中的时区 。 |
Rows | 不包括空白行标题、列名称和页脚元数据的报表记录数据的计数。 此元数据在 Xml 报表中不可用。 |
默认情况下,报表列名称包括“AccountId”、“CampaignId”、“KeywordId”、“DeviceType”、“Clicks”。 如果不希望报表列将 ExcludeColumnHeaders 设置为 true。
报表页脚元数据,例如 @2020 Microsoft Corporation。保留所有权限。 默认包含 。 如果不希望页脚元数据将 ExcludeReportFooter 设置为 true。
报表格式版本
某些字段的数据格式可以在当前 API 版本中更新,而不会中断现有客户端应用程序。 可以通过设置可选的 FormatVersion 请求字段来获取最新的数据格式。 下表总结了格式版本 1.0 和 2.0 之间的差异。
说明 | 报表列 | FormatVersion 1.0 示例 | FormatVersion 2.0 示例 |
---|---|---|---|
删除了逗号) (千组分隔符。 | AllRevenue 协助 ExtendedCost 收入 |
1,000.00 | 1000.00 |
精度从 4 位数字更新为 2 位。 | LowQualityClicksPercent LowQualityImpressionsPercent Ptr |
12.3400 | 12.34 |
精度从 0 位更新为 2 位。 | AbsoluteTopImpressionShareLostToBudgetPercent AbsoluteTopImpressionShareLostToRankPercent ExactMatchImpressionSharePercent ImpressionLostToBudgetPercent ImpressionLostToRankAggPercent ImpressionSharePercent TopImpressionShareLostToBudgetPercent TopImpressionShareLostToRankPercent |
12 | 12.34 |
每小时报表格式已从“mm/dd/yyyy 12:00:00 AM|hour”更新为“yyyy-mm-dd|hour”。 如果报表聚合设置为“每小时”,则此格式仅适用于 TimePeriod 列。 | TimePeriod | “3/15/2020 12:00:00 AM|7” | “2020-03-15|7” |
对数据进行分组的列
报表中包含的属性列会影响统计信息列中的值以及行数。 例如,如果请求的摘要报告仅包括 AccountId、CampaignId、Keyword、KeywordId 和 Clicks,则单击列将包含关键字 (keyword) 的单击次数,而不考虑排除的属性(如设备、匹配类型和网络)。
"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 2:55:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 2:55:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 3"
"AccountId","CampaignId","Keyword","KeywordId","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","95"
"YourAccountId","YourCampaignId","shoes delivered","234","1"
"YourAccountId","YourCampaignId","shoe sale","345","98"
"@2020 Microsoft Corporation. All rights reserved. "
如果随后包括 DeviceType 列,则报表将包含一行,用于关键字 (keyword) 和设备类型值的每个唯一组合,并且每行的单击列中的值将相应地细分。
"Report Name: My Keyword Performance Report"
"Report Time: 2/7/2020"
"Time Zone: (GMT-08:00) Pacific Time (US & Canada); Tijuana"
"Last Completed Available Day: 2/8/2020 2:55:00 PM (GMT)"
"Last Completed Available Hour: 2/8/2020 2:55:00 PM (GMT)"
"Report Aggregation: Summary"
"Report Filter: "
"Potential Incomplete Data: true"
"Rows: 7"
"AccountId","CampaignId","Keyword","KeywordId","DeviceType","Clicks"
"YourAccountId","YourCampaignId","red shoes","123","Computer","35"
"YourAccountId","YourCampaignId","red shoes","123","Smartphone","50"
"YourAccountId","YourCampaignId","red shoes","123","Tablet","10"
"YourAccountId","YourCampaignId","shoes delivered","234","Computer","1"
"YourAccountId","YourCampaignId","shoe sale","345","Computer","80"
"YourAccountId","YourCampaignId","shoe sale","345","Smartphone","5"
"YourAccountId","YourCampaignId","shoe sale","345","Tablet","13"
"@2020 Microsoft Corporation. All rights reserved. "
有关每种类型的可用列的详细信息,请参阅 报表属性和性能统计信息。
大多数报表都需要 TimePeriod 属性,因此还应考虑指定更精细的聚合周期(例如,在报表请求的 Aggregation 元素中按月)进一步细分单击数据。 例如,报表随后将包含关键字 (keyword) 、设备和月份的每个唯一组合的行。 仅包含单击次数的月份才会包含该行。
列限制
对于包含印象共享性能统计信息列的报表,不能在同一报表请求中包含约束属性。 如果包含任何印象共享性能统计信息列,则必须排除以下所有属性列。 同样,如果包括以下任一属性列,则必须排除所有展示共享性能统计信息列。
提交 AccountPerformanceReportRequest 和 AdGroupPerformanceReportRequest 时,以下属性和印象共享性能统计信息列互斥。
注意
此外,如果包括任何 AudienceImpressionLostToBudgetPercent、AudienceImpressionLostToRankPercent、AudienceImpressionSharePercent 或 RelativeCtr 列,则必须排除 CustomerId、CustomerName 和 DeliveredMatchType 属性列,反之亦然。
Attributes | 印象共享性能统计信息 |
---|---|
BidMatchType DeviceOS 目标 GoalType TopVsOther |
AbsoluteTopImpressionRatePercent AbsoluteTopImpressionShareLostToBudgetPercent AbsoluteTopImpressionShareLostToRankPercent AbsoluteTopImpressionSharePercent AudienceImpressionLostToBudgetPercent AudienceImpressionLostToRankPercent AudienceImpressionSharePercent ClickSharePercent ExactMatchImpressionSharePercent ImpressionLostToBudgetPercent ImpressionLostToRankAggPercent ImpressionSharePercent RelativeCtr |
提交 CampaignPerformanceReportRequest 时,以下属性和印象共享性能统计信息列互斥。
注意
此外,如果包括任何 AudienceImpressionLostToBudgetPercent、AudienceImpressionLostToRankPercent、AudienceImpressionSharePercent 或 RelativeCtr 列,则必须排除 CustomerId、CustomerName 和 DeliveredMatchType 属性列,反之亦然。
Attributes | 印象共享性能统计信息 |
---|---|
BidMatchType BudgetAssociationStatus BudgetName BudgetStatus DeviceOS 目标 GoalType TopVsOther |
AbsoluteTopImpressionRatePercent AbsoluteTopImpressionShareLostToBudgetPercent AbsoluteTopImpressionShareLostToRankPercent AbsoluteTopImpressionSharePercent AudienceImpressionLostToBudgetPercent AudienceImpressionLostToRankPercent AudienceImpressionSharePercent ClickSharePercent ExactMatchImpressionSharePercent ImpressionLostToBudgetPercent ImpressionLostToRankAggPercent ImpressionSharePercent RelativeCtr TopImpressionRatePercent TopImpressionShareLostToBudgetPercent TopImpressionShareLostToRankPercent TopImpressionSharePercent |
提交 HotelDimensionPerformanceReportRequest 时,以下属性受到限制。
Attributes |
---|
AdId |
提交 HotelGroupPerformanceReportRequest 时,以下属性受到限制。
Attributes |
---|
AdId |
提交 ProductDimensionPerformanceReportRequest 时,以下属性和印象共享性能统计信息列互斥。
Attributes | 印象共享性能统计信息 |
---|---|
AdDistribution AdId AdStatus ClickType ClickTypeId 目标 GoalType 语言 LocalStoreCode 网络 TopVsOther |
AbsoluteTopImpressionShareLostToBudgetPercent AbsoluteTopImpressionShareLostToRankPercent AbsoluteTopImpressionSharePercent BenchmarkBid BenchmarkCtr ClickSharePercent ImpressionLostToBudgetPercent ImpressionLostToRankPercent ImpressionSharePercent TopImpressionShareLostToBudgetPercent TopImpressionShareLostToRankPercent TopImpressionSharePercent |
提交 ProductPartitionPerformanceReportRequest 时,以下属性和印象共享性能统计信息列互斥。
Attributes | 印象共享性能统计信息 |
---|---|
AdDistribution AdId AdStatus BidMatchType ClickType ClickTypeId DeliveredMatchType 目标 GoalType 语言 LocalStoreCode 网络 TopVsOther |
AbsoluteTopImpressionSharePercent BenchmarkBid BenchmarkCtr ClickSharePercent ImpressionLostToBudgetPercent ImpressionLostToRankPercent ImpressionSharePercent |
时间段列
如果包括 TimePeriod 列,则下载的报表中值的格式将因在报表请求中指定的 报表聚合 级别而异。 例如,如果聚合级别为“每日”,则 TimePeriod 列中的每个字段都将包含格式为 yyyy-mm-dd 的日期。
注意
不支持对每周、每月和每年时间段列进行部分数据聚合。 如果所选日期不是完整的周/月/年,并且请求了相应的周/月/年时间段列,则所选日期将转换为完整的周/月/年。
聚集 | 说明 |
---|---|
每天 | 报表的每一行都标识事务发生的月份、日和年。 报表数据将按每天进行聚合。 时间段的格式将为 yyyy-mm-dd。 |
DayOfWeek | 报表的每一行都标识发生事务的星期几。 报表数据将按每周七天中的每一天进行聚合。 可能的数据值为 17,其中 1 - 表示星期日,7 表示星期六。 如果报表时间跨多个周,则一周中给定日期的所有周的性能数据将聚合在一行中。 例如,如果 市场活动 A 在每个星期一 (第 2 天) 5 次展示,则报告将包括一行 TimePeriod 列中 的 2 次,该行中的展示次数总计为 15。 |
每小时 | 报表的每一行标识事务发生的小时数。 报表数据将按一天中的每一小时聚合。 默认情况下,时间段的格式为日期和小时 (int 值) 单个管道分隔,即“mm/dd/yyyy 12:00:00 AM|hour”,其中上午 12:00:00 可以忽略。 例如,如果单击发生在 2020 年 3 月 15 日 07:00 和 08:00 之间,则下载的报告中的字段将是“3/15/2020 12:00:00 AM|7”。 如果将报表 FormatVersion 设置为“2.0”,则时间段的格式将为“yyyy-mm-dd|hour”。 例如,如果单击发生在 2020 年 3 月 15 日 07:00 和 08:00 之间,则下载报表中的字段将为“2020-03-15|7”。 小时部分的可能值为 0 - 23。 如果报表时间跨多天,则给定小时的性能数据将跨多个行单独提供,即报表将包含一行,表示每个唯一的一天和一小时。 例如,如果 市场活动 A 在报告时间范围中包含的 3 天中,第 7 小时 每一天有 5 次展示,则报表将包含 3 行,每个行 7 小时 5 次展示。 |
HourOfDay | 报表的每一行都标识发生事务的一天中的小时。 报表数据将按所有天数的 24 小时进行聚合。 可能的值为 0 - 23。 如果报表时间跨多天,则给定小时的所有天数的性能数据将聚合在一行中。 例如,如果 市场活动 A 在报告时间范围中包含的 3 天中的每 7 小时内有 5 次展示,则报表将包含一行 ,HourOfDay 的展示次数总计为 15。 |
每月 | 报表的每一行都标识事务发生的月份。 报表数据将按月聚合。 包含月份第一天的时间段的格式将设置为 yyyy-mm-dd。 |
每周 | 报表的每一行都标识事务发生的周。 报表数据将每周进行聚合。 包含每周星期日日期的时间段的格式为 yyyy-mm-dd。 |
每年 | 报表的每一行标识事务发生的年份。 报表数据将按每年进行聚合。 包含年份的时间段的格式将设置为 yyyy。 |
聚合和时间
对于大多数报表请求,必须设置 聚合 和 时间 元素。 下面是可为每个聚合值指定的时间段。
聚合值 | 时间段 |
---|---|
每天 | Today 昨天 LastSevenDays ThisMonth LastMonth 自定义日期范围 |
DayOfWeek | Today 昨天 LastSevenDays ThisMonth LastMonth LastThreeMonths LastSixMonths |
每小时 | Today 昨天 自定义日期范围 |
HourOfDay | Today 昨天 LastSevenDays ThisMonth LastMonth LastThreeMonths LastSixMonths |
每月 | ThisMonth LastMonth LastThreeMonths LastSixMonths ThisYear LastYear 自定义日期范围 |
摘要 | Today 昨天 LastSevenDays ThisMonth LastMonth 自定义日期范围 |
每周 | ThisWeek LastWeek LastFourWeeks ThisMonth LastMonth ThisYear LastYear 自定义日期范围 |
每年 | ThisYear LastYear 自定义日期范围 |
零印象
如果印象发生在请求的时间段之前,然后在请求的时间段内发生了后续操作(如单击、转换或电话呼叫),则报表数据可以包含零印象的行。 同样,即使在请求的时间段内,如果下载上周的每日性能报告,则所有展示都可能发生在星期日,然后点击或其他性能发生,例如星期一或星期二。 周一或周二的报表数据可能具有零曝光次数的点击次数。 可以使用 批量服务 或 市场活动管理服务 来获取帐户中的所有实体,无论它们是否具有任何关联的性能数据。
报告中的时区
下载的报表数据始终相对于 UTC 时间。 例如,每小时报表可能会将 5 次点击数归为第 7 小时。 在这种情况下,5 次单击发生在 07:00 到 08:00 UTC 之间。
ReportTimeZone 请求元素确定用于建立今天日期的时区。 提交报告请求时,今天的日期可能因时区而异。 选择的报告时间段(例如,“昨天”)是相对于今天日期的。 如果未选择时区,则报告服务默认使用 PacificTimeUSCanadaTijuana。 例如,在 2020 年 2 月 2 日凌晨 2 点东部时间USCanada 为“昨天”指定时区的情况下请求的报告将被解释为 2020 年 1 月 31 日的请求。 同时请求的“昨天”且时区设置为 EasternTimeUSCanada 的报告将解释为 2020 年 2 月 1 日的请求。
ReturnOnlyCompleteData 请求元素确定服务是否必须确保所有数据都已处理且可用。 如果设置为 true ,并且系统尚未根据请求的聚合、范围和时间完成所有数据的处理,则服务将返回错误代码 NoCompleteDataAvaliable (2004) 。 否则,默认情况下,请求可以成功,则不会指示数据是否完成,并且报告将仅包含系统在请求时已完成处理的数据。 虽然目前仍在进行中,但可以通过不请求已完成的数据来获取最新数据。 然后,在当天的书籍关闭后,你可能想要将此标志设置为 true,并回顾现在的“昨天”,并获取最终报告数据。
注意
如果请求针对具有不同时区的市场活动报告,则只有在当天结束并且点击数据已在所有市场活动时区中处理后,才会认为数据已完成。 例如,假设您请求的报告包括市场活动 A (指定 PST 时区) ,市场活动 B (指定 EST 时区) ,则在指定时间段内处理市场活动 A 的所有点击数据之前,数据不会完成。
当用户单击广告时,系统最多可能需要 2 小时才能处理点击 (3 小时,以便) 转换并使其可供报告。 数据通常被视为完整,书籍在 3 小时后关闭。 在某些异常情况下,由于流量无效,可能会出现意外调整,可能需要一周或更多时间才能解决。 例如,如果广告客户投诉发现逃避自动过滤系统的无效点击活动,流量质量和支持团队将处理广告客户帐户的信用额度,并将与内部团队合作,以确定他们是否可以更新自动化系统,以便改进将来的检测。 有关详细信息,请参阅 交通质量中心。
MRC 认证指标
搜索广告点击量指标由媒体分级委员会 (MRC) 认证;此认证不适用于任何其他指标。 有关详细信息,请参阅 方法的单击度量说明 。