従来版の 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 の UI ですでに作成されている必要があります。
`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 の UI ですでに作成されている必要があります。
`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`	同期レポートのみ。レポートの行に対して実行する並べ替えを定義する列と方向のリスト。 1 回のリクエストあたりの注文の最大数は 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 の UI ですでに作成されている必要があります。
`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 から始まるインデックス。{`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`	レポートのすべての統計情報が同じタイムゾーンのものである場合は、このタイムゾーンが使用されます。それ以外の場合は、フィールドが設定されていません。

Methods

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