Google Analytics Data API の概要

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

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

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

Google アナリティクス Data API v1 を使用してレポートを作成できるデータの例を以下に示します。

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

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

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

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

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