Core Reporting API - 概要

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このドキュメントでは、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 つの基本概念の上に成り立っています。

  1. レポートとユーザーやビュー(旧プロファイル)との関係
  2. レポートの構成とクエリの作成方法
  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 で使用できるクライアント ライブラリの一覧は、ライブラリとサンプルのページをご覧ください。

トップへ戻る