Google Analytics Data API の概要

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

利用可能なメソッド

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 スキーマに関するドキュメントをご覧ください。