Google Analytics Data API の概要

Data API を使用して、 Google アナリティクス（Google Analytics）のレポートデータにプログラムでアクセスできます。この API は、従来のユニバーサル アナリティクス プロパティとは互換性がありません。

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

Google アナリティクス 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 などの言語のクライアント ライブラリが用意されています。

利用可能なメソッド

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 アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。ファネルデータ探索では、ユーザーがコンバージョンに至るまでのステップをビジュアル表示し、各ステップでのユーザーの動向をすばやく確認できます。

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

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