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 で各ページの 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 スキーマのドキュメントをご覧ください。