従来版の Search Ads 360 Reporting API は、2024 年 6 月 30 日に廃止され、廃止されます。なお、Search Ads 360 Conversion API は影響を受けず、引き続きサポートされます。新しいレポートの作成には、必ず新しい Search Ads 360 Reporting API を使用してください。

2024 年 4 月以降、レポートをリクエストすると、unsupportedApiVersion エラーが返されます。詳しくはこちらをご覧ください。

また、既存の検索広告 360 の実装を新しい API に移行することを強くおすすめします。詳しくは、新しい Search Ads 360 Reporting API のスタートガイドと移行ガイドをご覧ください。

このページは Cloud Translation API によって翻訳されました。

Reports

このリソースのメソッドの一覧は、このページの最後に掲載されています。

リソース表記

DoubleClick Search レポート。このオブジェクトには、レポートリクエスト、一部のレポートメタデータ（通貨コードなど）、生成されたレポートの行またはレポートファイルが含まれます。

{
  "kind": "doubleclicksearch#report",
  "id": string,
  "isReportReady": boolean,
  "request": {
    "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
  },
  "statisticsCurrencyCode": string,
  "statisticsTimeZone": string,
  "rowCount": integer,
  "files": [
    {
      "url": string,
      "byteCount": long
    }
  ],
  "rows": [
    {
      (key): (value)
    }
  ]
}

プロパティ名	値	説明
`files[]`	`list`	非同期レポートのみ。レポートが正常に完了した後、生成されたレポートファイルのリストが含まれます。
`files[].byteCount`	`long`	このレポートファイルのサイズ（バイト単位）。
`files[].url`	`string`	この URL を使用してレポートファイルをダウンロードします。
`id`	`string`	非同期レポートのみ。レポートの ID。
`isReportReady`	`boolean`	非同期レポートのみ。レポートが正常に完了し、レポートファイルをダウンロードする準備ができている場合にのみ true になります。
`kind`	`string`	これが Report リソースであることを識別します。値: 固定文字列 `doubleclicksearch#report`。
`request`	`nested object`	レポートを作成したリクエスト。元のリクエストで指定されていないオプションフィールドは、デフォルト値で入力されます。
`request.columns[]`	`list`	レポートに含める列。これには、DoubleClick Search の列と保存済みの列の両方が含まれます。DoubleClick Search 列の場合、`columnName` パラメータのみが必須です。保存済みの列の場合、`savedColumnName` パラメータのみが必須です。`columnName` と `savedColumnName` の両方を同じスタンザに設定することはできません。リクエストあたりの最大列数は 300 列です。
`request.columns[].columnName`	`string`	レポートに含める DoubleClick Search 列の名前。
`request.columns[].customDimensionName`	`string`	カスタムディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタムディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタムディメンション名では、大文字と小文字が区別されます。コンバージョンレポートで使用する場合、特定のコンバージョンで指定されたカスタムディメンションの値を返します（設定されている場合）。この列ではコンバージョンレポートは分割されません。
`request.columns[].customMetricName`	`string`	レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
`request.columns[].endDate`	`string`	包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`startDate` と一緒に指定する必要があります。
`request.columns[].groupByColumn`	`boolean`	同期レポートのみ。この列でグループ化するには、`true` に設定します。デフォルトは `false` です。
`request.columns[].headerText`	`string`	レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは `columnName` または `savedColumnName` です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
`request.columns[].platformSource`	`string`	カスタムディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
`request.columns[].productReportPerspective`	`string`	特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです: 「`sold`」: 販売された商品の指標のみを返します「`advertised`」: ショッピングキャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます
`request.columns[].savedColumnName`	`string`	レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
`request.columns[].startDate`	`string`	YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`endDate` と一緒に指定する必要があります。
`request.downloadFormat`	`string`	レポートの返される形式。現在、`csv` または `tsv` がサポートされています。
`request.filters[]`	`list`	レポートに適用されるフィルタのリスト。リクエストあたりのフィルタの最大数は 300 です。
`request.filters[].column`	`nested object`	フィルタを実行する列。これは、DoubleClick Search の列または保存済みの列です。
`request.filters[].column.columnName`	`string`	レポートに含める DoubleClick Search 列の名前。
`request.filters[].column.customDimensionName`	`string`	カスタムディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタムディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタムディメンション名では、大文字と小文字が区別されます。コンバージョンレポートで使用する場合、特定のコンバージョンで指定されたカスタムディメンションの値を返します（設定されている場合）。この列ではコンバージョンレポートは分割されません。
`request.filters[].column.customMetricName`	`string`	レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
`request.filters[].column.endDate`	`string`	包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`startDate` と一緒に指定する必要があります。
`request.filters[].column.groupByColumn`	`boolean`	同期レポートのみ。この列でグループ化するには、`true` に設定します。デフォルトは `false` です。
`request.filters[].column.headerText`	`string`	レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは `columnName` または `savedColumnName` です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
`request.filters[].column.platformSource`	`string`	カスタムディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
`request.filters[].column.productReportPerspective`	`string`	特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです: 「`sold`」: 販売された商品の指標のみを返します「`advertised`」: ショッピングキャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます
`request.filters[].column.savedColumnName`	`string`	レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
`request.filters[].column.startDate`	`string`	YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`endDate` と一緒に指定する必要があります。
`request.filters[].operator`	`string`	フィルタで使用する演算子。使用可能な演算子のリストについては、フィルタリファレンスをご覧ください。
`request.filters[].values[]`	`list`	列の値をフィルタする値のリスト。リクエストあたりのフィルタ値の最大数は 300 です。
`request.includeDeletedEntities`	`boolean`	削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは `false` です。非推奨。代わりに `includeRemovedEntities` を使用してください。
`request.includeRemovedEntities`	`boolean`	削除されたエンティティをレポートに含めるかどうかを決定します。デフォルトは `false` です。
`request.maxRowsPerFile`	`integer`	非同期レポートのみ。レポートファイルあたりの最大行数。このフィールドに基づいて、サイズの大きいレポートは多数のファイルに分割されます。有効な値は `1000000`～`100000000` です。
`request.orderBy[]`	`list`	同期レポートのみ。レポートの行の並べ替えを定義する列と方向のリスト。リクエストあたりの注文の最大数は 300 です。
`request.orderBy[].column`	`nested object`	並べ替えを実行する列。DoubleClick Search で定義された列または保存済みの列を使用できます。
`request.orderBy[].column.columnName`	`string`	レポートに含める DoubleClick Search 列の名前。
`request.orderBy[].column.customDimensionName`	`string`	カスタムディメンションでレポートを分割します。レポートのスコープを広告主以下にし、カスタムディメンションが DoubleClick Search ですでに設定されている必要があります。DoubleClick Search に表示されるカスタムディメンション名では、大文字と小文字が区別されます。コンバージョンレポートで使用する場合、特定のコンバージョンで指定されたカスタムディメンションの値を返します（設定されている場合）。この列ではコンバージョンレポートは分割されません。
`request.orderBy[].column.customMetricName`	`string`	レポートに含めるカスタム指標の名前。レポートのスコープを広告主以下にし、カスタム指標を DoubleClick Search ですでに設定しておく必要があります。DoubleClick Search に表示されるカスタム指標名では大文字と小文字が区別されます。
`request.orderBy[].column.endDate`	`string`	包含日（YYYY-MM-DD 形式）。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`startDate` と一緒に指定する必要があります。
`request.orderBy[].column.groupByColumn`	`boolean`	同期レポートのみ。この列でグループ化するには、`true` に設定します。デフォルトは `false` です。
`request.orderBy[].column.headerText`	`string`	レポート出力でこの列を識別するために使用されるテキスト。指定しない場合のデフォルトは `columnName` または `savedColumnName` です。これにより、DoubleClick Search の列と同じ名前の保存済みの列が競合するのを防ぐことができます。
`request.orderBy[].column.platformSource`	`string`	カスタムディメンションのデータを提供するために使用されるプラットフォームです。有効な値は「floodlight」です。
`request.orderBy[].column.productReportPerspective`	`string`	特定の種類の商品アクティビティの指標のみを返します。指定できる値は次のとおりです: 「`sold`」: 販売された商品の指標のみを返します「`advertised`」: ショッピングキャンペーンで宣伝された商品のうち、販売された可能性がある商品と販売されていない可能性のある商品のみの指標が返されます
`request.orderBy[].column.savedColumnName`	`string`	レポートに含める保存済み列の名前。レポートのスコープは広告主以下にする必要があります。また、この保存された列は、DoubleClick Search 管理画面であらかじめ作成しておく必要があります。
`request.orderBy[].column.startDate`	`string`	YYYY-MM-DD 形式の日付を含む。指定した場合、この列のレポート全体の期間のみがオーバーライドされます。`endDate` と一緒に指定する必要があります。
`request.orderBy[].sortOrder`	`string`	並べ替えの方向。`ascending` または `descending` のいずれかです。
`request.reportScope`	`object`	reportScope は、レポートで返されるエンティティのサブセットを決定するために使用される ID のセットです。代理店を通じて希望する最も下位のスコープレベルの ID の完全なリネージが必要です。
`request.reportScope.adGroupId`	`long`	DS 広告グループ ID。
`request.reportScope.adId`	`long`	DS 広告 ID。
`request.reportScope.advertiserId`	`long`	DS 広告主 ID。
`request.reportScope.agencyId`	`long`	DS 代理店 ID。
`request.reportScope.campaignId`	`long`	DS キャンペーン ID。
`request.reportScope.engineAccountId`	`long`	DS エンジンアカウント ID。
`request.reportScope.keywordId`	`long`	DS キーワード ID。
`request.reportType`	`string`	レポートに返される行の種類を指定します。たとえば、`reportType: keyword` を指定した場合、レポートの各行にはキーワードに関するデータが含まれます。各タイプで使用できる列については、レポートのタイプのリファレンスをご覧ください。
`request.rowCount`	`integer`	同期レポートのみ。返される行の最大数。残りの行は破棄されます{`0`/} 以上 `10000` 以下の値を指定できます。デフォルト値は `10000` です。
`request.startRow`	`integer`	同期レポートのみ。返される最初の行のゼロベースのインデックス。{`0`/} 以上 `50000` 以下の値を指定できます。デフォルト値は `0` です。
`request.statisticsCurrency`	`string`	金額を返す通貨を指定します。有効な値は `usd`、`agency`（レポートの対象が代理店以下である場合に有効）、`advertiser`（レポートの対象が * 広告主以下である場合に有効）、または `account`（レポートの対象がエンジンアカウント以下である場合に有効）です。
`request.timeRange`	`object`	レポートで指標がリクエストされた場合、この引数を使用して指標を特定の期間に限定します。
`request.timeRange.changedAttributesSinceTimestamp`	`datetime`	RFC 形式の UTC タイムスタンプ。例:`2013-07-16T10:16:23.555Z`。変更された属性レポートの仕組みに関するその他のリファレンスをご覧ください。
`request.timeRange.changedMetricsSinceTimestamp`	`datetime`	RFC 形式の UTC タイムスタンプ。例:`2013-07-16T10:16:23.555Z`。変更された指標レポートの仕組みに関するその他の参考資料をご覧ください。
`request.timeRange.endDate`	`string`	YYYY-MM-DD 形式の日付を含む。
`request.timeRange.startDate`	`string`	YYYY-MM-DD 形式の日付を含む。
`request.verifySingleTimeZone`	`boolean`	`true` の場合、リクエストされたすべての統計情報データが単一のタイムゾーンから取得されている場合にのみ、レポートが作成されます。デフォルトは `false` です。
`rowCount`	`integer`	レポートによって生成されたレポートの行数（ヘッダーは除く）。
`rows[]`	`list`	同期レポートのみ。生成されたレポート行。
`rows[].(key)`	`any value`	この行で表される列を示します。つまり、各キーは、その行内に空白でないセルがある列に対応しています。
`statisticsCurrencyCode`	`string`	レポートで作成されたすべての金銭的価値の通貨コード。ユーザーが設定した値（キーワードの入札単価など）と指標（費用、収益など）が含まれます。レポートの通貨コードは、レポートリクエストの `statisticsCurrency` フィールドによって決まります。
`statisticsTimeZone`	`string`	レポートのすべての統計情報が同じタイムゾーンから収集されたものであれば、問題ありません。それ以外の場合、このフィールドは設定されません。

メソッド

生成: レポートをすぐに生成して返します。
get: レポートリクエストのステータスをポーリングします。
getFile: UTF-8 でエンコードされたレポートファイルをダウンロードします。
getIdMappingFile: 検索広告 360 従来版とリニューアル版間の ID マッピングを含む CSV ファイル（UTF-8 エンコード）をダウンロードします。リクエストされた広告主のファイルには、検索広告 360 の従来版とリニューアル版の両方に存在するすべての子エンティティ（エンジンアカウント、キャンペーン、広告グループなど）が含まれます。
リクエスト: レポートリクエストをレポートシステムに挿入します。