ReportRequest 資料物件 - 報告
定義所有報表要求的基底物件。
請勿具現化這個物件。 相反地,您可以具現化其中一個衍生自此物件的報表要求物件,例如 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物件具有下列元素:ExcludeColumnHeaders、ExcludeReportFooter、ExcludeReportHeader、Format、FormatVersion、ReportName、ReturnOnlyCompleteData。
元素 | 說明 | 資料類型 |
---|---|---|
ExcludeColumnHeaders | 判斷下載的報表是否應該包含每個資料行的標頭描述。 報表資料行標頭符合要求的資料行名稱,例如 [曝光數 ] 和 [ 按一下]。 如果您想要將報表資料行標頭從下載的報表中排除,請將此屬性設定 為 true 。 預設值為 false。 |
布林 |
ExcludeReportFooter | 判斷下載的報表是否應該包含頁尾中繼資料,例如 Microsoft 著作權 (@2020 Microsoft Corporation。保留的擁有權限。) 。 如果您想要將報表頁尾中繼資料從下載的報表中排除,請將此屬性設定 為 true 。 預設值為 false。 |
布林 |
ExcludeReportHeader | 判斷下載的報表是否應該包含標頭中繼資料,例如報表名稱、日期範圍和匯總。 如果您想要從下載的報表中排除報表標頭中繼資料,請將此屬性設為 true 。 預設值為 false。 |
布林 |
格式 | 報表資料的格式。 例如,您可以要求以逗號分隔值 (Csv) 格式或索引標籤分隔值 (Tsv) 格式的資料。 預設值為 Csv。 所有下載的檔案都會壓縮。 |
ReportFormat |
FormatVersion | 決定所下載報表檔案中特定欄位的格式。 某些欄位的資料格式可以在目前的 API 版本內更新,而不會中斷現有的用戶端應用程式。 您可以將此選擇性要求欄位設定為 2.0,以取得最新的資料格式。 如果您未設定此欄位,服務預設為 1.0 版。 如需格式版本之間變更的詳細資訊,請 參閱報表格式版本。 |
string |
ReportName | 報表的名稱。 名稱包含在報表標頭中。 如果您未指定報表名稱,系統會以 ReportType-ReportDateTime 格式產生名稱。 報表名稱的最大長度為 200。 |
string |
ReturnOnlyCompleteData | 判斷服務是否必須確定所有資料都已處理且可供使用。 如果設為 true ,而且系統尚未根據要求的匯總、範圍和時間完成處理所有資料,服務會傳回錯誤碼 NoCompleteDataAvaliable (2004) 。 否則,根據預設,要求可能會成功,並不會指出資料是否已完成,而且報表只會包含系統在要求時已完成處理的資料。 請注意,由於目前仍在進行中,而且資料尚未完成,因此如果時間週期 (自訂或預先定義的日期) 包含今天的日期,您就無法將此元素設定為 true 。 如需詳細資訊,請參閱 報表中的時區。 |
布林 |
需求
服務: ReportingService.svc v13
命名 空間: https://bingads.microsoft.com/Reporting/v13