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 です。 |
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 に設定することはできません。 詳細については、「 レポートのタイム ゾーン」を参照してください。 |
boolean |
要件
サービス: ReportingService.svc v13
名前 空間： https://bingads.microsoft.com/Reporting/v13