ProductDimensionPerformanceReportRequest 数据对象 - 报告

定义产品维度性能报告请求,该请求按指定时间段的产品类别、自定义标签、标题和类型聚合性能数据。 可以在报表中包含详细信息,例如展示次数、点击次数和支出,这些展示次数、点击次数和支出可用于确定产品维度是否表现良好。

若要请求此类型的报表,请将此对象传递给 SubmitGenerateReport 操作。

注意

应仅使用此报表来获取Microsoft购物市场活动的性能数据。 它不适用于其他市场活动类型。

注意

如果选择了“AdGroupName”、“AdGroupId”、“AdGroupStatus”、“AdId”、“AdStatus”列,并且未选择“AssetGroupId”、“AssetGroupName”、“AssetGroupStatus”、“CampaignType”列,则不会返回性能最大市场活动数据。

如果选择了 “AssetGroupId”、“ AssetGroupName”、“ AssetGroupStatus”和 “CampaignType” 列,则 “AdGroupName”、“ AdGroupId”、“ AdGroupStatus”、“ AdId”、“ AdStatus” 列可以为“性能最大”市场活动数据为 null。

语法

<xs:complexType name="ProductDimensionPerformanceReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension base="tns:ReportRequest">
      <xs:sequence>
        <xs:element name="Aggregation" type="tns:ReportAggregation" />
        <xs:element name="Columns" nillable="true" type="tns:ArrayOfProductDimensionPerformanceReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:ProductDimensionPerformanceReportFilter" />
        <xs:element name="Scope" nillable="true" type="tns:AccountThroughAdGroupReportScope" />
        <xs:element name="Time" nillable="true" type="tns:ReportTime" />
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>

元素

ProductDimensionPerformanceReportRequest 对象具有以下元素:AggregationColumnsFilterScopeTime

元素 说明 数据类型
集合体 用于聚合报表数据的聚合类型。 例如,可以按天或周聚合报表数据,或者请求摘要报表。

默认聚合为“摘要”。 请务必注意,如果未在 列表中包括 TimePeriod,则将忽略所选聚合,并且无论如何都会使用摘要聚合。
ReportAggregation
列数 要包含在报表中的属性和性能统计信息的列表。 报表将按指定列的顺序包含列。 ProductDimensionPerformanceReportColumn 数组
筛选器 用于筛选报表数据的筛选器信息。 ProductDimensionPerformanceReportFilter
范围 报表的实体范围。

使用此元素将报表数据限制为特定帐户、广告组或市场活动。
AccountThroughAdGroupReportScope
时间 用于报表的时间段。 可以指定自定义日期范围或选择预定义的日期范围,例如 Today 或 ThisWeek。

有关可为每个聚合类型指定的时间段的列表,请参阅 聚合和时间

可以在 ReportTime 对象中设置时区,这有助于准确确定所请求时间段的数据范围。

如果未选择时区,则报告服务默认使用 PacificTimeUSCanadaTijuana。
ReportTime

ProductDimensionPerformanceReportRequest 对象具有 Inherited Elements

继承的元素

从 ReportRequest 继承的元素

ProductDimensionPerformanceReportRequest 对象派生自 ReportRequest 对象,并继承以下元素:ExcludeColumnHeadersExcludeReportFooterExcludeReportHeaderFormatFormatVersionReportNameReturnOnlyCompleteData。 下面的说明特定于 ProductDimensionPerformanceReportRequest,可能不适用于从 ReportRequest 对象继承相同元素的其他对象。

元素 说明 数据类型
ExcludeColumnHeaders 确定下载的报表是否应包含每列的标题说明。 报表列标题与请求的列名称匹配,例如“展示次数”和“点击次数”。

如果希望从下载的报表中排除报表列标题,请将此属性设置为 true 。 默认值为 false
boolean
ExcludeReportFooter 确定下载的报表是否应包含页脚元数据,例如Microsoft版权 (@2020 Microsoft Corporation。保留所有权限。) 。

如果希望从下载的报表中排除报表页脚元数据,请将此属性设置为 true 。 默认值为 false
boolean
ExcludeReportHeader 确定下载的报表是否应包含标头元数据,例如报表名称、日期范围和聚合。

如果希望从下载的报表中排除报表标头元数据,请将此属性设置为 true 。 默认值为 false
boolean
格式 报表数据的格式。 例如,可以请求以逗号分隔值 (Csv) 格式或制表符分隔值 (Tsv) 格式的数据。

默认值为 Csv。

所有下载的文件都是 ZIP 压缩的。
ReportFormat
FormatVersion 确定下载的报表文件中某些字段的格式。

某些字段的数据格式可以在当前 API 版本中更新,而不会中断现有客户端应用程序。 可以通过将此可选请求字段设置为 2.0 来获取最新的数据格式。 如果未设置此字段,则服务默认为版本 1.0。

有关格式版本之间的更改的详细信息,请参阅 报表格式版本
string
ReportName 报表的名称。 名称包含在报表标头中。 如果未指定报表名称,系统会以 ReportType-ReportDateTime 格式生成名称。

报表名称的最大长度为 200。
string
ReturnOnlyCompleteData 确定服务是否必须确保所有数据都已处理且可用。

如果设置为 true ,并且系统尚未根据请求的 聚合范围时间完成所有数据的处理,则服务将返回错误代码 NoCompleteDataAvaliable (2004) 。 否则,默认情况下,请求可以成功,则不会指示数据是否完成,并且报告将仅包含系统在请求时已完成处理的数据。

请注意,由于今天仍在进行中,并且数据不完整,因此如果“时间段” (自定义日期还是预定义日期) 包括今天日期,则无法将此元素设置为 true。 有关详细信息,请参阅 Reporting 中的时区
boolean

要求

服务: ReportingService.svc v13
Namespace: https://bingads.microsoft.com/Reporting/v13