Google アナリティクス Data API の概要

Data API を使用して、Google アナリティクス（Google アナリティクス）のレポートデータにプログラムでアクセスできます。

詳しくは、Google アナリティクスのプロパティをご覧ください。

API から返されるデータは、Google アナリティクスのユーザー インターフェースに表示されるデータと一致しており、Google アナリティクス プロパティに設定されているレポート用識別子の設定（ブレンド、実測、デバイスベースなど）が完全に反映されます。

Google Analytics Data API v1 を使用してレポートを作成できる例をいくつかご紹介します。

  • 対象の Android アプリは先週、1 日あたりのアクティブ ユーザー数が何人いたか
  • サイトの上位 10 ページが過去 28 日間に獲得したページビュー数。
  • 対象 iOS アプリの過去 30 分間の国別アクティブ ユーザー数。

Google アナリティクス Data API v1 を使用して、次のこともできます。

  • Google アナリティクスのデータを表示するカスタマイズされたマイレポートを作成する。
  • 複雑なレポートタスクを自動化して時間を節約する。
  • Google アナリティクスのデータを他のビジネス アプリケーションと統合する。

データの整合性とレポート用識別子

Google Analytics Data API v1 は、Google アナリティクスのインターフェースと同じレポートデータにアクセスします。API から返されるデータは、Google アナリティクスのプロパティに設定されたレポート用識別子の設定を完全に尊重するため、ユーザー数、重複除去、データ モデリングは、プロパティ設定で選択されたユーザー識別スペース（ブレンド、実測、デバイスベースなど）と一致します。

さまざまなユーザー識別スペースがレポートに与える影響について詳しくは、レポート用識別子をご覧ください。

始める

使用を開始するには、クライアント ライブラリのクイックスタートをご覧ください。実装を簡素化するために、Java、Python、Node.js などの言語のクライアント ライブラリが用意されています。

利用可能なメソッド

Data API のメソッドのリストは次のとおりです。詳細については、リファレンス ドキュメントをご覧ください。

  • runReport このメソッドは、Google アナリティクスのイベントデータのカスタム レポートを返します。シンプルなレポートクエリには、このメソッドを使用することをおすすめします。
  • batchRunReports: runReport メソッドのバッチ バージョンです。単一の API 呼び出しで複数のレポートを生成できます。
  • runPivotReport このメソッドは、Google アナリティクスのイベントデータのカスタマイズされたピボット レポートを返します。ピボット レポートは、通常のレポートよりも高度で表現力豊かな形式です。各ピボットは、レポート レスポンスに表示されるディメンションの列と行を表します。
  • batchRunPivotReports runPivotReport メソッドのバッチ バージョンです。単一の API 呼び出しで複数のレポートを生成できます。
  • getMetadata このメソッドは、レポート メソッドで使用できるディメンションと指標のメタデータを返します。ディメンションと指標の探索に使用されます。このメソッドのレスポンスには、指定された Google アナリティクスのプロパティで使用可能なカスタム ディメンションとカスタム指標も含まれます。
  • checkCompatibility このメソッドは、レポート リクエストに追加して互換性を維持できるディメンションと指標を一覧表示します。
  • runRealtimeReport このメソッドは、プロパティのカスタマイズされたリアルタイム イベントデータのレポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイム レポートに表示されます。リアルタイム レポートには、現在から 30 分前（Google アナリティクス 360 プロパティでは最大 60 分前）の期間のイベントと使用状況データが表示されます。
  • properties.audienceExports オーディエンス内のユーザーのスナップショットを含むオーディエンス エクスポートを生成できるメソッドのグループ。
  • properties.recurringAudienceLists （早期プレビュー） 定期的なオーディエンス エクスポートを管理できるメソッドのグループ。繰り返しオーディエンスのエクスポートでは、毎日新しいオーディエンス リストが生成されます。
  • runFunnelReport （早期プレビュー版） このメソッドは、Google アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。ファネル データ探索では、ユーザーがタスクを完了するまでのステップをビジュアル表示し、各ステップでのユーザーの動向を簡単に確認できます。
  • properties.chat （早期プレビュー版） このメソッドは、Google アナリティクスの Ask Advisor へのプログラマティックな会話アクセスを提供します。イベントデータに関する質問を自然言語で行い、パフォーマンスの変化を診断し、構造化されたナラティブと表形式の分析情報を取得できます。

サポートされているディメンションと指標

Data API でサポートされているすべてのディメンションと指標のリストについては、API スキーマに関するドキュメントをご覧ください。