このドキュメントでは、Management API を使用してビュー(旧プロファイル)のデータにアクセスする方法について説明します。
はじめに
Google アナリティクスのビュー リソースは、アカウント階層構造の第三レベルのエンティティです。各ビューには単一のウェブ プロパティ リソースが階層構造の親エンティティとして割り当てられていて、0 または複数の目標リソースを子エンティティとして割り当てることができます。
- ビューと他の Management API エンティティの関係については、Management API の概要ガイドでエンティティの概要をご覧ください。
- アカウントの全般情報については、アカウントとビューのコンセプト ガイドをご覧ください。
すべてのレポートはビュー単位で実行されるため、Google アナリティクスのビューは重要です。Core Reporting API に対してクエリを実行する場合、各 ids
クエリで table Id パラメータを指定して、どのビューからデータにアクセスするかを特定する必要があります。ビューリソースごとに table Id パラメータが返されます。
準備
- Java
- Python
- PHP
- Management API で利用できるプログラミング言語ごとのクライアント ライブラリは、クライアント ライブラリ ページにまとめられています。
- クライアント ライブラリを使用せずに API にアクセスする方法については、リファレンス ガイドをご覧ください。
各クライアント ライブラリは、すべての Management API データにアクセスするための 1 つの Analytics
サービス オブジェクトを提供します。このサービス オブジェクトを作成するには、通常、次の手順に従います。
- Google Developers Console でアプリケーションを登録します。
- Google アナリティクス データへのアクセスを承認します。
Analytics
サービス オブジェクトを作成します。
上記の手順を完了していない場合は、まず Google Analytics API についてのチュートリアルをご覧ください。このチュートリアルでは、Google Analytics API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、このガイドを使用して実環境で作業できるようになります。
次のコード スニペットは、手順 3(Analytics サービス オブジェクトの作成)の続きであり、承認済みのサービス オブジェクトを格納する変数が含まれます。
Java
Analytics analytics = // Read Hello Analytics Tutorial for details.
Python
analytics = # Read Hello Analytics Tutorial for details.
PHP
$client = // Read Hello Analytics Tutorial for details. // Return results as objects. $client->setUseObjects(true); $analytics = new apiAnalyticsService($client);
PHP ライブラリからすべての API の結果が連想配列として返されます。実際のオブジェクトが返されるようにするには、上記の例で示したように、クライアントの useObject
メソッドを呼び出します。
Analytics
サービス オブジェクトを作成すれば、Management API にリクエストを送信するための準備は完了です。
注: この Analytics
サービス オブジェクトを使用して Core Reporting API にアクセスすることもできます。
テスト アカウントの使用
Management API を使ってビューを作成、設定する場合、テスト アカウントでコードを実装、テストすることをおすすめします。テスト アカウントを使うことで、アクティブなビューが誤って変更されないようにすることができます。テスト アカウントとビューを使ってコードをテストし、コードが期待通りに機能していることを確認できたら、実際のアカウントでコードを実装できるようになります。
テスト アカウントは、Google アナリティクス管理画面の [アナリティクス設定] ページで作成できます。
ビュー(旧プロファイル)の制限事項と動作
プロファイル リソースには、以下の制限事項と動作が適用されます。
- プロパティあたりのビューは、デフォルトで 25 個までという上限があります。担当の Google アカウント マネージャーにお問い合わせいただき、上限の引き上げをご依頼いただくと、プレミアム以外のプロパティの場合は 200 個、プレミアム プロパティの場合は 400 個に引き上げることができます。アカウントがこの上限に達すると、既存のビューを 1 つ以上削除しない限り、API から追加のビューを作成することはできません。ただし、既存のビューを更新、再利用することはできます。制限事項全般については、制限と割り当てを参照してください。
サンプルコード
Management API を使用すると、認証されたユーザーのビューを一覧表示、取得、挿入、更新、削除することができます。ビューにパッチを適用することも可能です。これらのメソッドを使用するには、始める前に
セクションの説明に従い、まず Analytics サービス オブジェクトを作成する必要があります。
プロファイル リソースを扱う方法を示すサンプルコードについては、以下のメソッド リファレンスをご覧ください。
- list - ユーザーがアクセスできるビューを一覧表示します。
- get - ユーザーがアクセスできるビューを取得します。
- insert - 新しいビューを作成します。
- patch - 既存のビューにパッチを適用します。このメソッドはパッチの動作をサポートしています。
- patch - 既存のビューを更新します。
- delete - ビューを削除します。
サンプル アプリケーション
Management API ですべてのデータを走査してアクセスする方法の実際の例については、Management API リファレンスのサンプルをご覧ください。
Java
Google アナリティクス API の Java クライアント ライブラリ サンプル
Python
Google アナリティクス API の Python クライアント ライブラリ サンプル
PHP
Google アナリティクス API の PHP クライアント ライブラリ サンプル