標準のユニバーサルアナリティクス（UA）プロパティでは、2023 年 7 月 1 日をもってデータの処理が停止されました。UA 360 プロパティでは、2024 年 7 月 1 日をもってデータの処理が停止されます。また、Google アナリティクス 4 への移行に伴い、一部の UA 360 の機能はその前にサポート終了となります。Admin API を使用して、GA4 プロパティのプロビジョニングと管理を行います。

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

非サンプリングレポートに関するデベロッパーガイド

Google アナリティクス Management API を使用すると、プログラムによって非サンプリングレポートを作成することができます。

はじめに

非サンプリングレポートは、サンプリングされていないデータを使用して生成された Google アナリティクスのレポートです。非サンプリングレポートは現在、Google アナリティクス 360 をご利用の方のみがご利用いただけます。

この API を使用すると、次のことが可能になります。

既存のすべての非サンプリングレポートに関する構成情報の取得、1 回限りの非サンプリングレポートの作成。
非サンプリングレポートの処理ステータスを確認する
処理が完了した時点で、非サンプリングレポートのデータファイルへのリンクを取得する
非サンプリングレポートを削除する

非サンプリングレポートのデータの取得

非サンプリングレポートを作成する場合、レポートをダウンロードできるようになるまでに、ある程度時間がかかることがあります。非サンプリングレポートの status フィールドは、そのレポートの処理が完了したかどうかを示します。ステータスが COMPLETED とマークされたら、downloadType と対応するダウンロードの詳細フィールドを使用して、レポートデータを含むファイルを取得できます。次に例を示します。

downloadType 値が GOOGLE_DRIVE の場合は、driveDownloadDetails フィールドを使用します。
downloadType 値が GOOGLE_CLOUD_STORAGE の場合は、cloudStorageDownloadDetails フィールドを使用します。

すぐに 1 日の割り当て量に達してしまう可能性が高いため、これらのレポートのステータスを確認するのに、頻繁に高速ポーリングを実行しないでください。非サンプリングレポートのステータスをチェックする際は、リクエスト間にインターバルを設けてください。

Google ドライブまたは Google Cloud Storage API の使用

ファイルが配信される場所（Google ドライブまたは Google Cloud Storage）に応じて、そのファイルに対応するリンクを取得します。このリンクを使用すると、Drive API または Cloud Storage API を使用してファイルをダウンロードできます。ファイルを取得する方法について詳しくは、Google Drive API または Google Cloud Storage API のドキュメントをご覧ください。

たとえば、非サンプリングレポートが Google ドライブに保存されている場合は、そのファイルのリソース URL に対して承認済みの HTTP GET リクエストを行い、クエリパラメータ alt=media を含めます。

GET /drive/v2/files/XXXXXX?alt=media
Host: www.googleapis.com
Content-length: 0
Authorization: Bearer ya29.AHESVbXTUv5mHMo3RYfmS1YJonjzzdTOFZwvyOAUVhrs

ここで、XXXXXX は非サンプリングレポート driveDownloadDetails.documentId です。

認証

非サンプリングレポートを Drive API または Cloud Storage API と組み合わせてファイルのダウンロードに使用する場合は、OAuth 2.0 トークンをリクエストする際に、Analytics API の認証スコープに加えて、その API に対応する認証スコープを含める必要があります。そうすることで、両方の API に同じ認証トークンを使用することができます。

非サンプリングレポートの削除

スケジュール設定済みまたは完了した非サンプリングレポートは削除できますが、レポートの生成中の短い期間に delete を呼び出すとエラーになります。非サンプリングレポートを削除すると、GA ビュー（旧プロファイル）からリソースだけが削除され、Google ドライブまたは Google Cloud Strage にエクスポートされたデータは残ります。

制限

非サンプリングレポートを作成する場合、以下の制限が適用されます。

指定できるディメンションは最大 4 つです。
一部のレポートデータ（Google 広告データなど）はサポートされていません。
高額すぎるとみなされたクエリはサポートされません。
非サンプリングレポートを作成しすぎてしまい、上限に達した場合は、非サンプリングレポートのリソースを削除しても問題ありません（Google ドライブや Google Cloud に生成済みのレポートデータはそのまま残ります）。

リクエストが高額すぎると判断された場合、作成操作によって適切なメッセージとエラーが返されます。この場合の対処法は次のとおりです。

リクエストするディメンションの数を減らします。
期間を短くしてクエリを複数に分割し、結果のレポートを合成します。

ユースケース

非サンプリングレポートと Core Reporting API

Core Reporting API を使ってレポートデータを取得し、そのデータにサンプルデータが含まれている場合は、以下の手順で同じクエリに対して非サンプリングレポートを作成できます。

Core Reporting API のリクエストを実行します。
レスポンスの containsSampledData プロパティを見て、データがサンプリング済みかどうかを確認します。
このプロパティが true に設定されている場合は、同じレスポンスの query フィールドと profileInfo フィールドを使って、非サンプリングレポートに対するリクエストを作成できます。

次のように、Core Reporting API レスポンスから query フィールドをサンプリングします。

"query": {
  "start-date": "2011-01-01",
  "end-date": "2011-01-31",
  "ids": "ga:1234",
  "dimensions": "ga:browser",
  "metrics": [
  "ga:visits"
  ],
  "filters": "ga:country==US",
  "start-index": 1,
  "max-results": 1000
}

Core Reporting API のレスポンスの profileInfo フィールドの例:

"profileInfo": {
  "profileId": "1234",
  "accountId": "12345",
  "webPropertyId": "UA-12345-1",
  "internalWebPropertyId": "11254",
  "profileName": "Name of the profile",
  "tableId": "ga:1234"
}

Core Reporting API のレスポンスから非サンプリングレポートを作成する方法の例を次に示します。

Java

// Make a Core Reporting API call.
GaData reportingApiData = v3.data().ga().get(...).execute();

// Check if the response is sampled.
if (reportingApiData.getContainsSampledData()) {

  // Use the “query” object to construct an unsampled report object.
  Query query = reportingApiData.getQuery();
  UnsampledReport report = new UnsampledReport()
      .setDimensions(query.getDimensions())
      .setMetrics(Joiner.on(',').join(query.getMetrics()))
      .setStartDate(startDate)
      .setEndDate(endDate)
      .setSegment(query.getSegment())
      .setFilters(query.getFilters())
      .setTitle(“My unsampled report”);

  // Use “profileInfo” to create an InsertRequest for creating an
  // unsampled report.
  ProfileInfo profileInfo = reportingApiData.getProfileInfo();
  Insert insertRequest = analytics.management().unsampledReports()
  .insert(profileInfo.getAccountId(),
          profileInfo.getWebPropertyId(),
          profileInfo.getProfileId(),
          report);
  UnsampledReport createdReport = insertRequest.execute();
}

複数日の非サンプリングデータの合成

複数日のレポートを結合または合成すると、特定の期間で非サンプリングデータを取得することができます。この方法は、非サンプリングデータのリクエストのサイズが大きすぎる場合に役立ちます。このような場合、期間を短くしてリクエストを複数に分割してから、結果を結合します。

割り当てポリシー

非サンプリングレポートの作成時に適用される制限事項と割り当てのリストについては、Configuration API と Reporting API の制限と割り当てをご覧ください。