Data API を使用して、Google アナリティクスのレポートデータに プログラムでアクセスできます。
詳しくは、Google アナリティクスの プロパティをご覧ください。
API から返されるデータは、Google アナリティクス ユーザー インターフェースに表示されるデータと一致し、 Google アナリティクス プロパティに設定されているレポート用識別子（ブレンド、観測、デバイスベースなど）の設定を完全に尊重します。
Google Analytics Data API v1 を使用してレポートできる例をいくつかご紹介します。
- 対象の Android アプリは先週、1 日あたりのアクティブ ユーザー数が何人いたか。
- 対象のサイトの上位 10 ページの過去 28 日間のページビュー数はどれくらいか。
- 対象 iOS アプリの過去 30 分間の国別アクティブ ユーザー数はどれくらいか。
Google Analytics Data API v1 を使用して、次のこともできます。
- Google アナリティクスのデータを表示するカスタマイズされたマイレポートを作成する。
- 複雑なレポートタスクを自動化して時間を節約する。
- Google アナリティクスのデータを他のビジネス アプリケーションと統合する。
データの整合性とレポート用識別子
Google Analytics Data API v1 は、Google アナリティクス インターフェースと同じレポートデータにアクセスします。API から返されるデータは、Google アナリティクスのプロパティに設定されているレポート用識別子 の設定を完全に尊重するため、ユーザー数、重複除去、データ モデリングは、プロパティ設定で選択したユーザー識別スペース（ブレンド、観測、デバイスベースなど）と一致します。
さまざまな識別スペースがレポートに与える影響について詳しくは、 レポート用識別子をご覧ください。
始める
Java、Python、Node.js、PHP、C#、Go、または Ruby のクライアント ライブラリを使用するには、クライアント ライブラリのクイックスタートをご覧ください。クエリの作成方法、ディメンションのフィルタリング方法、レスポンスの読み取り方法については、レポートを作成する、またはクエリ エクスプローラでクエリをインタラクティブにテストするをご覧ください。
runReport リクエストとレスポンスのサンプル
REST 経由でイベントデータをクエリするには、POST リクエストを
runReport エンドポイントに、
RunReportRequest
JSON 本文を使用して送信し、dateRanges、dimensions、metrics を指定します。
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
"dateRanges": [
{ "startDate": "7daysAgo", "endDate": "yesterday" }
],
"dimensions": [
{ "name": "country" }
],
"metrics": [
{ "name": "activeUsers" }
]
}
または、アプリケーションのデフォルト
認証情報を使用して、同等の curl コマンドを実行します。
curl -X POST \
"https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "x-goog-user-project: PROJECT_ID" \
-H "Content-Type: application/json" \
-d '{
"dateRanges": [
{ "startDate": "7daysAgo", "endDate": "yesterday" }
],
"dimensions": [
{ "name": "country" }
],
"metrics": [
{ "name": "activeUsers" }
]
}'
API は、RunReportResponse
列ヘッダーとデータ行を含む を返します。
{
"dimensionHeaders": [
{ "name": "country" }
],
"metricHeaders": [
{ "name": "activeUsers", "type": "TYPE_INTEGER" }
],
"rows": [
{
"dimensionValues": [{ "value": "United States" }],
"metricValues": [{ "value": "4820" }]
},
{
"dimensionValues": [{ "value": "Japan" }],
"metricValues": [{ "value": "2541" }]
}
],
"rowCount": 2,
"kind": "analyticsData#runReport"
}
利用可能なメソッド
Data API メソッドのリストを以下に示します。詳細については、リファレンス ドキュメントをご覧ください。
runReportこのメソッド は、Google アナリティクスのイベントデータのカスタマイズされたレポートを返します。簡単なレポートクエリにはこの メソッドを使用することをおすすめします。batchRunReportsこれは runReport メソッドのバッチ バージョンで、1 回の API 呼び出しで複数のレポートを生成できます。runPivotReportこの メソッドは、Google アナリティクス のイベントデータのカスタマイズされたピボット レポートを返します。ピボット レポートは、通常のレポートよりも高度で表現力豊かな形式です。各ピボットは、レポート レスポンスに表示されるディメンションの列と行を表します。batchRunPivotReportsこれは runPivotReport メソッドのバッチ バージョンで、1 回の API 呼び出しで複数のレポートを生成できます。getMetadataこのメソッドは、レポート メソッドで使用できるディメンションと指標のメタデータを返します。 ディメンションと指標を調べるために使用します。このメソッドのレスポンスには、指定した Google アナリティクスのプロパティで使用できるカスタム ディメンションと指標も含まれます。checkCompatibilityこのメソッドは、レポート リクエストに追加して互換性を維持できるディメンションと指標を一覧表示します。runRealtimeReportこのメソッドは、プロパティのリアルタイム イベント データのカスタマイズされたレポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイム レポートに表示されます。リアルタイム レポートには、現在から 30 分前（Google アナリティクス 360 プロパティの場合は最大 60 分前）の期間のイベントと使用状況データが表示されます。properties.audienceExportsオーディエンスのエクスポートを 生成できるメソッドのグループ。オーディエンスのエクスポートには、オーディエンス内のユーザーのスナップショットが含まれます。properties.recurringAudienceLists（早期プレビュー） 定期的なオーディエンスのエクスポートを管理できるメソッドのグループ。定期的なオーディエンスのエクスポートでは、毎日新しいオーディエンス リストが生成されます。runFunnelReport（早期プレビュー版） このメソッドは、Google アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。ファネルデータ探索では、ユーザーがタスクを完了するまでのステップをビジュアル表示し、各ステップでのユーザーの動向を簡単に確認できます。properties.chat（早期プレビュー版） このメソッドを使用すると、Google アナリティクスの Ask Advisor にプログラマティックに会話形式でアクセスできます。イベントデータに関する自然言語の質問をしたり、パフォーマンスの変化を診断したり、構造化されたナラティブ形式と表形式の分析情報を受け取ったりできます。
サポートされているディメンションと指標
Data API でサポートされているすべてのディメンションと指標のリストについては、 API スキーマに関するドキュメントをご覧ください。