このドキュメントでは、Management API を使用して、認証済みユーザーが Google アナリティクスのカスタム ディメンションとカスタム指標を管理する方法を説明します。
はじめに
Management API のカスタム ディメンションとカスタム指標により、Google アナリティクス プロパティでカスタム ディメンションやカスタム指標の作成、取得、リスト、更新や、パッチの適用を行えます。カスタム ディメンションとカスタム指標の仕組みについては、カスタム ディメンションとカスタム指標の機能に関するリファレンスをご覧ください。
Management API の以下の 2 つのリソースを使用すると、カスタム ディメンションとカスタム指標の管理を自動化できます。
- カスタム ディメンションのリソース。Google アナリティクスで利用できるカスタム ディメンションのすべてのプロパティと設定を示します。
- カスタム指標のリソース。Google アナリティクスで利用できるカスタム指標のすべてのプロパティと設定を示します。
事前の準備
Google アナリティクス API はすべて同じ方法でアクセスできます。Management API を使用する前に、以下の準備をしてください。
- API を扱うプログラミング言語固有のクライアント ライブラリのリストについてクライアント ライブラリ ページで確認します。
- API インターフェースと、クライアント ライブラリを使わずにデータにアクセスする方法についてリファレンス ガイドで確認します。
各クライアント ライブラリは、すべての Management API データにアクセスするための 1 つの Analytics サービス オブジェクトを提供します。サービス オブシェクトを作成する方法は次のとおりです。
- Google Developers Console でアプリケーションを登録します。
- Google アナリティクス データへのアクセスを承認します。
- Analytics サービス オブジェクトを作成します。
上記の手順を完了していない場合は、まず Google アナリティクス API についてのチュートリアルをご覧ください。このガイドでは、Google アナリティクス API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、Google アナリティクス API を実際の作業に活用する方法を理解することができます。
スコープの変更とデータの不一致
詳細については、カスタム ディメンションとカスタム指標の機能に関するリファレンスの実装に関する注意事項セクションを参照してください。
使用例
Management API のカスタム ディメンションとカスタム指標を利用して、次の作業を自動化することができます。
- プロパティのカスタム ディメンションとカスタム指標を一覧表示する
- プロパティで新しいカスタム ディメンションとカスタム指標を作成する
- プロパティの既存のカスタム ディメンションとカスタム指標を更新する
プロパティのカスタム ディメンションとカスタム指標を一覧にする
プロパティのすべてのカスタム ディメンションとカスタム指標を一覧にする方法は次のとおりです。
- Management API かアカウント エクスプローラを使用して、アカウント ID とプロパティ ID を取得します。
- カスタム ディメンションまたはカスタム指標リソースの
listメソッドを実行します。
次のリソース向けの list メソッドに関する詳細は API リファレンスを参照してください:
カスタム ディメンション リソース
カスタム指標リソース
プロパティの新しいカスタム ディメンションとカスタム指標を作成する
プロパティの新しいカスタム ディメンションとカスタム指標を作成する方法は次のとおりです。
- Management API か Account Explorer を使用して、アカウント ID とプロパティ ID を取得します。
- カスタム ディメンションとカスタム指標には両方とも、
nameとscopeを指定する必要があります。カスタム指標については、指標のtypeも選択する必要があります。 - カスタム ディメンションまたはカスタム指標リソースの
insertメソッドを実行します。
次のリソース向けの insert メソッドに関する詳細は API リファレンスを参照してください:
カスタム ディメンション リソース
カスタム指標リソース
プロパティの既存のカスタム ディメンションとカスタム指標を更新する
カスタム ディメンションまたはカスタム指標の名前、スコープ、型を更新することにより、別の目的でこれを利用することもできます。ただし、更新する前に、ディメンションと指標への変更の影響について再検討することをおすすめします。
プロパティの既存のカスタム ディメンションとカスタム指標を更新する方法は次のとおりです。
- Management API か Account Explorer を使用して、アカウント ID とプロパティ ID を取得します。
- カスタム ディメンションとカスタム指標には両方とも、
nameとscopeを指定する必要があります。カスタム指標については、指標のtypeも設定する必要があります。 - カスタム ディメンションまたはカスタム指標リソースの
updateメソッドを実行します。
カスタム データソースまたはデータセット リンクを無視する
カスタム データソースかデータセット リンクで使用されているカスタム ディメンションまたはカスタム指標を、Management API を使って更新しようとすると、その操作は失敗し、エラーが返されます。ここでは、スコープが変更されると、データの不一致が生じることがあるため、ディメンションまたは指標のスコープが誤って変更されるのを防ぐためにエラーが返されるようになっています。この動作をオーバーライドしてすべての警告を無視するには、更新操作を実行する際に ignoreCustomDataSourceLinks パラメータを true に設定します。
サンプルコード
認証済みユーザーは、カスタム ディメンションとカスタム指標リソースを利用して、カスタム ディメンションとカスタム指標のリスト、取得、更新、パッチの適用、挿入を実行できます。これらのメソッドを使用するには、事前の準備セクションの説明に従い、まず Analytics サービス オブジェクトを作成する必要があります。
カスタム ディメンションとカスタム指標を扱う例を示すサンプルコードについては、次のメソッド リファレンスをご覧ください。
カスタム ディメンションの管理
- list - ユーザーがアクセスできるカスタム ディメンションを一覧表示します。
- get - ユーザーがアクセスできるカスタム ディメンションを取得します。
- insert - 新しいカスタム ディメンションを作成します。
- patch - 既存のカスタム ディメンションにパッチを適用します。
- update - 既存のカスタム ディメンションを更新します。
カスタム指標の管理
- list - ユーザーがアクセスできるカスタム指標を一覧表示します。
- get - ユーザーがアクセスできるカスタム指標を取得します。
- insert - 新しいカスタム指標を作成します。
- patch - 既存のカスタム指標にパッチを適用します。
- update - 既存のカスタム指標を更新します。