このドキュメントでは、Google アナリティクス Core Reporting API バージョン 3.0 の概要を説明します。API の詳細なリファレンスについては、リファレンス ガイドをご覧ください。
はじめに
Google アナリティクスのほとんどのレポートデータには、Google アナリティクスの Core Reporting API を使ってアクセスできます。Core Reporting API によって次を実行できます。
- Google アナリティクスのデータを表示するカスタマイズされたマイレポートを作成する。
- 複雑なレポート処理を自動化して時間を節約する。
- Google アナリティクスのデータを他のビジネス アプリケーションと統合する。
バージョンの選択
先日、新バージョンの Core Reporting API が発表されました。
- 新しいアプリケーションを構築する場合は、– 最新バージョン 3.0 を使用することをおすすめします。
- 以前のバージョン 2.3 をお使いの場合アプリを更新して新しいバージョンを使用する方法については、 移行ガイドをご覧ください。
スタートガイド
今すぐ利用を開始する場合は、アナリティクス API についてのチュートリアルをご覧ください。
API を使用するアプリケーションごとに、登録、ユーザーの承認、API の操作のために、いくつかのステップを実行する必要があります。このチュートリアルでは、各ステップを順を追って説明します。最終的には、カスタマイズ可能な動作中のアプリケーションが作成されます。
コンセプトの概要
Core Reporting API は、Google アナリティクスのトラッキング コードによって収集されたデータを基に各種の統計情報から成るレポートデータを返します。各レポートは、ディメンションと指標で構成されています。 カスタム レポートを作成するには、Core Reporting API を使用してディメンションと指標をクエリします。
Core Reporting API は、次の 3 つの基本概念の上に成り立っています。
- レポートとユーザーやビュー（旧プロファイル）との関係
- レポートの構成とクエリの作成方法
- API レスポンスの処理
レポート、ユーザー、ビュー（旧プロファイル）
ユーザーのレポートデータをリクエストするには、アプリケーションでユーザーを識別し、データを取得するビューを指定する必要があります。ユーザーは、各 API リクエストで 認証情報を取得して渡すことで識別されます。ビューは Google アナリティクスの 構成階層の一部であり、ビュー ID で識別されます。
ビュー ID を確認するには、いくつかの方法があります。
- アプリケーションから Management API を使用して Management 構成階層を走査し、ビュー ID を取得する。
- Google アナリティクスの各レポートの URL。
スクショ
- Google アナリティクスのメニューバーで、[管理] をクリックします。ビューが属しているアカウントとプロパティ
を選択する。[ビュー] 列で [ビュー設定] をクリックして、ビュー ID を取得します。
スクリーンショット
ディメンションと指標のクエリ
ディメンションと指標で構成される Google アナリティクスのレポートデータに対して、API に対してクエリを実行します。 指標とは、セッション数やページビュー数など、プロパティにおけるユーザー アクションの個別の測定値のことです。ディメンションは、国やブラウザなどの一般的な条件に基づいて指標を分類します。クエリを作成するときに、レポートデータに含めるディメンションと指標を指定します。
API を通じて公開されるすべてのディメンションと指標については、インタラクティブな ディメンションと指標のリファレンス ガイドをご覧ください。API クエリでディメンションと指標を指定する方法については、 Core Reporting API リファレンス ガイドをご覧ください。
レポートの処理
API から返されるデータは、ヘッダーと一連の行から成る表とみなすことができます。各 API レスポンスは、それぞれの列の名前とデータタイプを示すヘッダーによって構成されます。また、レスポンスには一連の行が格納され、各行の一連のセルに、ヘッダーと同じ順序でデータが格納されています。個々のセルに格納されているデータタイプは、ヘッダーの情報を基に判断することができます。
API レスポンスの詳細については、Core Reporting API リファレンス ガイドをご覧ください。
割り当てとサポート終了に関するポリシー
Google アナリティクスの API では、何百万という操作が処理されます。そこで、送信データがシステムで処理できる操作の量を超えてしまわないようにするためにも、またシステム リソースを公平に配分するためにも、割り当てシステムが必要になります。具体的な制限については、制限と割り当てのガイドをご覧ください。
Core Reporting API の列（ディメンションと指標）に対する変更について、詳しくはデータのサポート終了に関するポリシーをご覧ください。 Metadata API を使用して非推奨の列を確認する方法については、 Metadata API デベロッパー ガイドをご覧ください。
次のステップ
API の仕組みを理解したところで、作業を開始するために次の一連の資料もご覧ください。
- API の使用については、デベロッパー ガイドをご覧ください。
- 対話形式の Query Explorer ツールを使用して、API クエリを視覚的に作成し、レスポンスを確認します。
- 一般的なクエリの記事をご覧ください。Core Reporting API のクエリの中でも特に一般的なものを紹介しています。
- API で利用できるデータの一覧については、ディメンションと指標のリファレンスをご覧ください。
- この API で使用できるクライアント ライブラリの一覧は、ライブラリとサンプルのページをご覧ください。