Data Export API - スタート ガイド

Analytics の Data Export API を使用するには、既存の Google Analytics アカウントとウェブサイト使用状況をトラッキングするプロファイルの両方にアクセスする必要があります。アプリケーションのユーザーも同様にアクセスする必要があります。Data Export API を使用して一定期間のトラフィックを収集した Analytics プロファイルからデータをエクスポートすると、ほとんどの情報を取得できます。

Google Analytics アカウントをまだお持ちでない場合は、こちらでお申し込みください。Analytics では Google アカウントを使用するため、既に Google アカウントをお持ちの場合はその ID を使用して Analytics アカウントを設定できます。お申し込み後、手順に従ってご自身のウェブサイトのトラッキング コードを設定します。Analytics Data Export API を使用して新しく作成した Analytics プロファイルから統計を取得する前に、Analytics レポートをチェックしてフィードに表示できるデータがあることを確認してください。

Google アカウントと Analytics アカウントの詳細については、アカウントとプロファイルのドキュメントを参照してください。

フィード取得の概要

Analytics アカウントとそのアカウント内のプロファイルの関係を理解することは重要です。アカウントとプロファイルのドキュメントを参照すると、フィードにデータを取り込む方法を理解できます。

次の 3 つの基本手順は、ウェブサイトから Analytics のフィード データを取得するためにアプリケーションで実行する必要のあるプロセスの概要を説明しています。

1. 認証

   アプリケーションにアクセスするユーザーは Analytics にログインする必要があります。通常、アプリケーションではユーザーのログイン認証情報が要求されます。アプリケーションが特定の Analytics プロファイルに関して記述されている場合、ユーザーはそのアカウントとアカウント内のプロファイルの両方へのアクセス権を持つ必要があります。プロファイルにアクセスするには、読み取りレベルの許可のみが必要です。ユーザーは Google アカウントのメールとパスワードを使用してログインできます。liz@gmail.com などです。

2. アカウントのクエリ

   ユーザーに Analytics のアクセス権があることがアプリケーションで確認後、ユーザーのアクセス先の Analytics アカウントを見つけます。ユーザーが、多数のアカウントや、そのアカウント内の多数のプロファイルへのアクセス権を持つ場合があることに注意してください。このため、アプリケーションでは最初にユーザーが使用できるアカウントのリストをリクエストしないとレポート情報にアクセスできません。それらのアカウント フィードによってそのリストが返されますが、そのリストにはユーザーが表示できるアカウントのプロファイルも含まれていることに注意してください。

3. プロファイル/レポートのクエリ

   プロファイルは Analytics レポートへの入口です。アプリケーションでは、使用できるプロファイルのリストから、ユーザーに表示するレポートのデータをリクエストできます。このリクエストの主要な内容は、アカウント フィードに指定されているプロファイルの ID です。この ID は、Analytics ウェブ インターフェースのプロファイル設定画面に表示されます。
   
   アカウント フィードではこの値を dxp:tableID フィールドに返します。これには、プロファイルの ID だけでなく名前空間プレフィクスが含まれています。レポートのクエリにはこのテーブル ID が必要であるため、この ID を取得するまではレポートのデータを取得できません。

ヒント:

• フィード データを取得するには、アカウント ID ではなくテーブル ID を使用します。

  ウェブサイトに関連付けられているのはプロファイルであるため、フィードのリクエストにはテーブル ID を使用する必要があります。リクエストにテーブル ID ではなくアカウント ID を含めた場合、クエリは失敗します。

• 確実な結果を取得するには 48 時間以上前の日付についてクエリを行います。

  Analytics のデータは 1 日中定期的に処理されていますが、24 時間分の収集データが最終的に確定するのは 1 日の終了時点から最大 48 時間後になります。

トップへ戻る

割り当てポリシー

Google Analytics の Data API では何百万ものオペレーションを処理します。システムが処理できないほど大量のオペレーションが発生しないようにするため、またシステムのリソースを公平に配分するために、割り当てシステムを採用する必要があります。このポリシーは変更されることがありますが、現在は以下のとおりです。

各 API リクエストはレスポンスあたり最大 10,000 エントリに制限されています。デフォルトではレスポンスあたり 1,000 エントリですが、max-results クエリ パラメータを使用して増やすことができます。

データ フィード

• 各ウェブ プロパティで 24 時間あたり 10,000 リクエスト（1 つのウェブ プロパティ内のすべてのプロファイル/テーブル ID）。
  この割り当ては毎晩回復します（太平洋標準時）。
• すべての Data Export API クエリで IP アドレスあたり 1 秒間 10 リクエスト（10 qps）。
• IP アドレスあたりの同時リクエスト数 4（5 番目のリクエストを行うには最初のリクエストが終了するのを待つ必要があります）。

アカウント フィード

• すべての Data Export API クエリで IP アドレスあたり 1 秒間 10 リクエスト（10 qps）。

割り当てを超過した場合、それ以上リクエストを行うと、Google Analytics API から 503 (Service Unavailable) HTTP ステータス コードと、続行するには特定のアカウントに割り当ての不足があることを示すメッセージがレスポンス本文に表示されます。詳細については、利用規約をご覧ください。

トップへ戻る

バージョンのアップグレード

アプリケーションを Google Analytics Data Export API バージョン 1 で開発した場合は、その後の作業を API バージョン 2 で続ける必要があります。もちろん、API バージョン 2 の新機能を取得するには、フィード リクエストを更新する必要があります。プロトコルを使用してアプリケーションを開発した場合は、プロトコル ガイドの "XML 解析ガイドライン" に従って API のバージョン間の競合を最小化することが重要です。クライアント ライブラリを使用してアプリケーションを開発した場合は、バージョン管理はクライアント ライブラリによって自動的に処理されます。

トップへ戻る