Analytics Data API の概要

Google アナリティクス Data API v1 を使用すると、Google アナリティクス 4(GA4)のレポートデータにプログラムでアクセスできます。Google アナリティクス 4 では、ウェブ、iOS、Android アプリがどのように使われているかを把握できます。Google アナリティクス 4 プロパティの詳細

Google Analytics Data API v1 を使用すると、次のような疑問の答えが得られるレポートを作成できます。

  • 先週の Android アプリの 1 日のアクティブ ユーザー数は?
  • 過去 28 日間のサイトの上位 10 件のページ URL のページビュー数は?
  • 過去 30 分間における iOS アプリのアクティブ ユーザー数(国別)

Google Analytics Data API v1 は、次の目的でも使用できます。

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

クイック スタートガイド

わずか数行のコードで API を呼び出して最初のレポートを作成できます。 使用方法については、クライアント ライブラリを使用したクイックスタートをご覧ください。Java、Python、Node.js などの言語のクライアント ライブラリを使用すると、実装を簡素化できます。

利用可能なメソッド

  • runReport: Google アナリティクス イベントデータのカスタム レポートを返します。シンプルなレポートクエリの場合に適しています。
  • batchRunReports: runReport メソッドのバッチ バージョンで、1 回の API 呼び出しで複数のレポートを生成できます。
  • runPivotReport: このメソッドは、Google アナリティクスのイベントデータのカスタマイズされたピボット レポートを返します。ピボット レポートは、通常のレポートよりも高度で表現力豊かな形式です。各ピボットは、レポート レスポンスに表示されるディメンションの列と行を表します。
  • batchRunPivotReports: runPivotReport メソッドのバッチ バージョンで、1 回の API 呼び出しで複数のレポートを生成できます。
  • getMetadata: このメソッドは、レポート メソッドで使用できるディメンションと指標のメタデータを返します。まずはディメンションと指標を確認します。このメソッドのレスポンスには、指定した GA4 プロパティで利用可能なカスタム ディメンションとカスタム指標も含まれます。
  • checkCompatibility。このメソッドは、レポート リクエストに追加したり互換性を維持したりできるディメンションと指標のリストを取得します。
  • runRealtimeReport: このメソッドは、プロパティのカスタマイズされたリアルタイム イベントデータ レポートを返します。イベントは、Google アナリティクスに送信されてから数秒後にリアルタイム レポートに表示されます。リアルタイム レポートには、現在から 30 分前(Google アナリティクス 360 プロパティの場合は最大 60 分)の期間のイベントと使用状況データが表示されます。
  • properties.audienceExports オーディエンス内のユーザーのスナップショットを含むオーディエンスのエクスポートを生成できるメソッドのグループ。
  • properties.recurringAudienceLists (早期プレビュー版)定期的なオーディエンスのエクスポートを管理できるメソッドのグループ。オーディエンスを定期的にエクスポートすることで 新しいオーディエンスリストが毎日生成されます
  • runFunnelReport (早期プレビュー)このメソッドは、Google アナリティクスのイベントデータのカスタマイズされた目標到達プロセス レポートを返します。ファネル データ探索では、ユーザーがタスクを完了するまでのステップを視覚化し、各ステップでのユーザーの動向をすばやく確認できます。

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

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