AudiencePerformanceReportRequest データ オブジェクト - レポート

  • [アーティクル]

対象ユーザーのパフォーマンス レポート要求を定義します。 このレポートを使用して、対象ユーザー、広告グループ、キャンペーン、またはアカウントの属性別に配信パフォーマンスの統計情報を比較します。

インプレッション数、クリック数、費用、平均クリック単価を要求できます。 ダウンロード後、このデータは対象ユーザー、関連付けの状態、広告グループ、ターゲット設定で並べ替えることができます。

この種類のレポートを要求するには、このオブジェクトを SubmitGenerateReport 操作に渡します。

構文

<xs:complexType name="AudiencePerformanceReportRequest" 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:ArrayOfAudiencePerformanceReportColumn" />
        <xs:element minOccurs="0" name="Filter" nillable="true" type="tns:AudiencePerformanceReportFilter" />
        <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>

要素

AudiencePerformanceReportRequest オブジェクトには、集計、列、フィルター、スコープ、時刻の各要素があります。

要素 説明 データ型
集計 レポート データの集計に使用する集計の種類。 たとえば、日または週別にレポート データを集計したり、サマリー レポートを要求したりできます。

既定の集計は [概要] です。 列の一覧に TimePeriod を含めなかった場合、選択した集計は無視され、サマリー集計は関係なく使用されることに注意してください。		 ReportAggregation
段組み レポートに含める属性とパフォーマンス統計の一覧。 レポートには、指定した順序で列が含まれます。 AudiencePerformanceReportColumn 配列
Filter レポート データのフィルター処理に使用するフィルター情報。 AudiencePerformanceReportFilter
範囲 レポートのエンティティ スコープ。

レポート データを特定のアカウント、広告グループ、またはキャンペーンに限定するには、この要素を使用します。		 AccountThroughAdGroupReportScope
時刻 レポートに使用する期間。 カスタム日付範囲を指定するか、定義済みの日付範囲 (Today や ThisWeek など) を選択できます。

集計の種類ごとに指定できる期間の一覧については、「集計 と時刻」を参照してください。

ReportTime オブジェクト内のタイム ゾーンを設定できます。これにより、要求された期間のデータを正確にスコープできます。

タイム ゾーンを選択しない場合、レポート サービスでは既定で PacificTimeUSCanadaTijuana が使用されます。		 ReportTime

AudiencePerformanceReportRequest オブジェクトには継承された要素があります。

継承された要素

ReportRequest から継承された要素

AudiencePerformanceReportRequest オブジェクトは ReportRequest オブジェクトから派生し、ExcludeColumnHeaders、ExcludeReportFooter、ExcludeReportHeader、Format、FormatVersion、ReportName、ReturnOnlyCompleteData の各要素を継承します。 以下の説明は AudiencePerformanceReportRequest に固有であり、 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 に設定することはできません。 詳細については、「 レポートのタイム ゾーン」を参照してください。		 boolean

要件

サービス: ReportingService.svc v13
名前 空間： https://bingads.microsoft.com/Reporting/v13