ReportRequest 数据对象 - Reporting

定义所有报表请求的基对象。

不要实例化此对象。 相反,可以实例化派生自此对象的报表请求对象之一,例如 CampaignPerformanceReportRequest。 有关报表的列表,请参阅 报表类型 指南。

语法

<xs:complexType name="ReportRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="ExcludeColumnHeaders" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportFooter" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="ExcludeReportHeader" nillable="true" type="xs:boolean" />
    <xs:element minOccurs="0" name="Format" nillable="true" type="tns:ReportFormat" />
    <xs:element minOccurs="0" name="FormatVersion" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReportName" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ReturnOnlyCompleteData" nillable="true" type="xs:boolean" />
  </xs:sequence>
</xs:complexType>

元素

ReportRequest 对象具有以下元素:ExcludeColumnHeadersExcludeReportFooterExcludeReportHeaderFormatFormatVersionReportNameReturnOnlyCompleteData

元素 说明 数据类型
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
命名 空间: https://bingads.microsoft.com/Reporting/v13

使用者

SubmitGenerateReport