Reports: request

レポート リクエストをレポート システムに挿入します。 実習をご覧ください。

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/doubleclicksearch/v2/reports

承認

このリクエストには、次のスコープによる認証が必要です。

スコープ
https://www.googleapis.com/auth/doubleclicksearch

詳細については、認証と認可のページをご覧ください。

リクエスト本文

リクエストの本文には、以下の構造を使用してデータを指定してください。

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}
プロパティ名 値 説明 メモ
reportScope object reportScope は、レポートで返されるエンティティのサブセットを決定するために使用される ID のセットです。代理店を通じて希望する最下位レベルの ID の完全なリネージが必要です。
reportScope.agencyId long DS 代理店 ID。
reportScope.advertiserId long DS 広告主 ID。
reportScope.engineAccountId long DS エンジン アカウント ID。
reportScope.campaignId long DS キャンペーン ID。
reportScope.adGroupId long DS 広告グループ ID。
reportScope.keywordId long DS キーワード ID。
reportScope.adId long DS 広告 ID。
reportType string レポートに返される行の種類を指定します。たとえば、reportType: keyword を指定した場合、レポートの各行にはキーワードに関するデータが含まれます。各タイプで使用できる列については、レポートのタイプのリファレンスをご覧ください。
columns[] list レポートに含める列。これには、DoubleClick Search の列と保存済みの列の両方が含まれます。DoubleClick Search 列の場合、columnName パラメータのみが必須です。保存済みの列の場合、savedColumnName パラメータのみが必須です。columnName と savedColumnName の両方を同じスタンザに設定することはできません。

リクエストあたりの最大列数は 300 列です。
columns[].columnName string レポートに含める DoubleClick Search 列の名前。
columns[].savedColumnName string レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
columns[].headerText string レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは columnName または savedColumnName です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
columns[].startDate string YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。endDate と一緒に指定する必要があります。
columns[].endDate string 包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。startDate と一緒に指定する必要があります。
columns[].groupByColumn boolean 同期レポートのみ。この列でグループ化するには、true に設定します。デフォルトは false です。
timeRange object レポートで指標がリクエストされた場合、この引数を使用して指標を特定の期間に限定します。
timeRange.startDate string YYYY-MM-DD 形式の日付を含む。
timeRange.endDate string YYYY-MM-DD 形式の日付を含む。
timeRange.changedMetricsSinceTimestamp datetime RFC 形式の UTC タイムスタンプ。例:2013-07-16T10:16:23.555Z。変更された指標レポートの仕組みに関するその他の参考資料をご覧ください。
timeRange.changedAttributesSinceTimestamp datetime RFC 形式の UTC タイムスタンプ。例:2013-07-16T10:16:23.555Z。変更された属性レポートの仕組みに関するその他のリファレンスをご覧ください。
filters[] list レポートに適用されるフィルタのリスト。

リクエストあたりのフィルタの最大数は 300 です。
filters[].column nested object フィルタを実行する列。これは、DoubleClick Search の列または保存済みの列です。
filters[].column.columnName string レポートに含める DoubleClick Search 列の名前。
filters[].column.savedColumnName string レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
filters[].operator string フィルタで使用する演算子。使用可能な演算子のリストについては、フィルタ リファレンスをご覧ください。
filters[].values[] list 列の値をフィルタする値のリスト。

リクエストあたりのフィルタ値の最大数は 300 です。
orderBy[] list 同期レポートのみ。レポートの行の並べ替えを定義する列と方向のリスト。

リクエストあたりの注文の最大数は 300 です。
orderBy[].column nested object 並べ替えを実行する列。DoubleClick Search で定義された列または保存済みの列を使用できます。
orderBy[].column.columnName string レポートに含める DoubleClick Search 列の名前。
orderBy[].column.savedColumnName string レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
orderBy[].sortOrder string 並べ替えの方向。ascending または descending のいずれかです。
includeDeletedEntities boolean 削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは false です。非推奨。代わりに includeRemovedEntities を使用してください。
verifySingleTimeZone boolean true の場合、リクエストされたすべての統計情報データが単一のタイムゾーンから取得されている場合にのみ、レポートが作成されます。デフォルトは false です。
downloadFormat string レポートの返される形式。現在、csv または tsv がサポートされています。
statisticsCurrency string 金額を返す通貨を指定します。有効な値は usd、agency（レポートの対象が代理店以下である場合に有効）、advertiser（レポートの対象が * 広告主以下である場合に有効）、または account（レポートの対象がエンジン アカウント以下である場合に有効）です。
startRow integer 同期レポートのみ。返される最初の行のゼロベースのインデックス。{0/} 以上 50000 以下の値を指定できます。デフォルト値は 0 です。
rowCount integer 同期レポートのみ。返される行の最大数。残りの行は破棄されます{0/} 以上 10000 以下の値を指定できます。デフォルト値は 10000 です。
maxRowsPerFile integer 非同期レポートのみ。レポート ファイルあたりの最大行数。このフィールドに基づいて、サイズの大きいレポートは多数のファイルに分割されます。有効な値は 1000000～100000000 です。
includeRemovedEntities boolean 削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは false です。
columns[].customDimensionName string カスタム ディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタム ディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム ディメンション名では、大文字と小文字が区別されます。

コンバージョン レポートで使用する場合、特定のコンバージョンで指定されたカスタム ディメンションの値を返します（設定されている場合）。この列ではコンバージョン レポートは分割されません。
columns[].platformSource string カスタム ディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
filters[].column.customDimensionName string カスタム ディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタム ディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム ディメンション名では、大文字と小文字が区別されます。

コンバージョン レポートで使用する場合、特定のコンバージョンで指定されたカスタム ディメンションの値を返します（設定されている場合）。この列ではコンバージョン レポートは分割されません。
filters[].column.headerText string レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは columnName または savedColumnName です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
filters[].column.startDate string YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。endDate と一緒に指定する必要があります。
filters[].column.endDate string 包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。startDate と一緒に指定する必要があります。
filters[].column.groupByColumn boolean 同期レポートのみ。この列でグループ化するには、true に設定します。デフォルトは false です。
filters[].column.platformSource string カスタム ディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
orderBy[].column.customDimensionName string カスタム ディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタム ディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタム ディメンション名では、大文字と小文字が区別されます。

コンバージョン レポートで使用する場合、特定のコンバージョンで指定されたカスタム ディメンションの値を返します（設定されている場合）。この列ではコンバージョン レポートは分割されません。
orderBy[].column.headerText string レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは columnName または savedColumnName です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
orderBy[].column.startDate string YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。endDate と一緒に指定する必要があります。
orderBy[].column.endDate string 包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。startDate と一緒に指定する必要があります。
orderBy[].column.groupByColumn boolean 同期レポートのみ。この列でグループ化するには、true に設定します。デフォルトは false です。
orderBy[].column.platformSource string カスタム ディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
columns[].customMetricName string レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
filters[].column.customMetricName string レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
orderBy[].column.customMetricName string レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
columns[].productReportPerspective string 特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです:
  • 「sold」: 販売された商品の指標のみを返します
  • 「advertised」: ショッピング キャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます
filters[].column.productReportPerspective string 特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです:
  • 「sold」: 販売された商品の指標のみを返します
  • 「advertised」: ショッピング キャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます
orderBy[].column.productReportPerspective string 特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです:
  • 「sold」: 販売された商品の指標のみを返します
  • 「advertised」: ショッピング キャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます

レスポンス

成功すると、このメソッドはレスポンスの本文で Reports リソースを返します。

試してみよう:

以下の API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。 または、 スタンドアロン エクスプローラをご覧ください。