概要

このドキュメントでは、Google Analytics Real Time Reporting API について説明します。API の詳細については、API リファレンス を ご覧ください。

はじめに

Real Time Reporting API では、認証されたユーザーのリアルタイム データ （プロパティのリアルタイム アクティビティなど）をリクエストすることが できます。

Real Time Reporting API は次のような目的に使用できます。

  • 在庫が少ない商品を見ているユーザーに、ページを閲覧中のユーザー数を 表示することで、その商品が品切れになってしまう可能性を示す。
  • 最もアクセスの多いページのトップ 10 など、人気の高いコンテンツを表示する。
  • リアルタイムのマイレポートを作成して表示する。

Google アナリティクス superProxy

Google アナリティクス superProxy を使用すると、API レスポンスの認証時、キャッシュ処理時、および視覚化と グラフ ライブラリで直接使用される形式に変換するときに、Google アナリティクス API での作業に関する実装の詳細の多くを処理できます。

コンセプトの概要

Real Time Reporting API の基本的な概念を以下に紹介します。

  • レポートとユーザーやビュー（旧プロファイル）との関係
  • レポートの構成とクエリの作成方法
  • API レスポンスの処理

レポート、ユーザー、ビュー（旧プロファイル）

ユーザーがアプリケーションを使用してビュー（旧プロファイル）からレポートデータを リクエストできるようにするには、以下の手順を実行する必要があります。

  1. Google アナリティクス API を有効にします。
  2. アプリケーションが API にアクセスするための認証情報を作成します。
  3. 作成した認証情報をアプリケーションに取り込みます。

アプリケーションを使用してレポートデータをリクエストする場合、ユーザーは、アプリケーション がデータにアクセスすることを代理で承認する必要があります。

ビュー（旧プロファイル）は、ビュー（旧プロファイル） ID で識別されます。 ビュー（旧プロファイル）は、他のエンティティとともに、アカウント、ユーザー、 プロパティ、およびビューからなる Google アナリティクス階層の一部です。 アプリケーションは、 Management API を使用して、この階層を走査し、ビュー（旧プロファイル）を取得できます。

ディメンションと指標のクエリ

ディメンションと指標によって構成されるレポートデータについて、Google アナリティクス API にクエリすることができます。指標とは、プロパティを利用中のアクティブ ユーザーの数など、ユーザー行動の個々の測定値のことです。 ディメンションは、指標をいくつかの一般的な条件（トラフィックの参照元、地域、 ページ情報など）を基に分類します。

API に 利用できるすべてのディメンションと指標についてはディメンションと 指標のリファレンス ガイドをご覧ください。API クエリでディメンションと指標を 指定する方法については Real Time Reporting API リファレンス ガイド を確認してください。

レポートの処理

API から返されるデータは、ヘッダーと一連の行から成る表とみなすことができます。各 API レスポンスは、それぞれの列の名前とデータタイプを示すヘッダーから構成されます。また、レスポンスには一連の行が格納され、各行の一連のセルに、ヘッダーと同じ順序でデータが格納されています。API レスポンスの詳細については、Real Time Reporting API リファレンス ガイドをご覧ください。

割り当てポリシー

Real Time Reporting API では、何百万ものデータクエリ操作が処理されます。そこで、 送信データがシステムで処理できる操作の量を超えてしまわないようにするためにも、 またシステム リソースを公平に配分するためにも、割り当てシステムを採用 しています。詳細については、 制限と割り当てガイドをご覧ください。

次のステップ

API の機能を理解したので、以下の作業を行います。