Management API - フィルタに関するデベロッパー ガイド

このドキュメントでは、認証済みのユーザーが Management API を使用して Google アナリティクスのフィルタを管理する方法について説明します。

はじめに

Management APIのフィルタを使用すると、Google アナリティクス アカウントのフィルタを作成、取得、一覧表示、更新、削除し、ビュー（プロファイル）にどのフィルタを適用するかを管理できます。フィルタの仕組みの詳細については、ビューフィルタについて（ヘルプセンター）を参照してください。

Management API には、フィルタの管理を自動化する以下の 2 つのリソースがあります。

  1. フィルタ リソースは、Google アナリティクスとその設定のフィルタを表します。フィルタ リソースのコレクションは、Google アナリティクス アカウントに関連付けられているすべてのフィルタを表します。
  2. プロファイル フィルタ リンク リソースは、フィルタとフィルタが適用されているビュー（旧プロファイル）のリンクを表します。プロファイル フィルタ リンクのコレクションは、現在ビュー（旧プロファイル）に適用されているすべてのフィルタを表します。

準備

Google アナリティクス API はすべて同じ方法でアクセスできます。Management API を使用する前に、以下の準備をしてください。

  • API を扱うプログラミング言語固有のクライアント ライブラリのリストについてクライアント ライブラリ ページで確認します。
  • API インターフェースと、クライアント ライブラリを使わずにデータにアクセスする方法についてリファレンス ガイドで確認します。

各クライアント ライブラリは、すべての Management API データにアクセスするための 1 つの Analytics サービス オブジェクトを提供します。このサービス オブジェクトを作成するには、通常、次の手順に従います。

  1. Google Developers Console でアプリケーションを登録します。
  2. Google アナリティクス データへのアクセスを承認します。
  3. Analytics サービス オブジェクトを作成します。

上記の手順を完了していない場合は、まず Google アナリティクス API についてのチュートリアルをご覧ください。このチュートリアルでは、Google アナリティクス API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、Google アナリティクス API を実際の作業に活用する方法を理解することができます。

使用例

Management API のフィルタを使用すると、アカウント全体の実践対策を一元化し、既存のフィルタの適用と削除を自動化できます。たとえば、次のような使い方ができます。

事前定義済みの設定 / 標準設定でのフィルタの作成

事前定義済みの設定で新しいフィルタを作成する手順は次のとおりです。

  1. Management API か管理画面を使って、新しいフィルタを適用するアカウントの ID を取得します。
  2. 事前定義済みの設定で filter リソースの insert メソッドを実行します。

詳細については、API リファレンスに記載された filter リソースの insert メソッドの説明をご覧ください。

ビュー（旧プロファイル）にフィルタを適用する手順は次のとおりです。

  1. Management API か管理画面を使って、フィルタが属するアカウントの ID を取得します。
  2. filter リソースを取得し、filter リソースの list メソッドを実行するか、filter リソースの get メソッドを実行して（フィルタの ID が分かっている場合）、フィルタをビュー（旧プロファイル）に適用します。
  3. Management API か管理画面を使って、フィルタを適用するアカウント ID、プロパティ ID、ビュー ID（旧プロファイル ID）を取得します。
  4. profileFilterLink リソースの insert メソッドを実行してフィルタを適用します。

詳細については、API リファレンス に記載された profileFilterLink リソースの insert メソッドの説明をご覧ください。

フィルタとビュー（旧プロファイル）のリンクを解除する手順は次のとおりです。

  1. Management API か管理画面を使って、フィルタを削除するアカウント ID、プロパティ ID、ビュー ID（旧プロファイル ID）を取得します。
  2. ビューから削除するプロファイル フィルタ リンクの ID を取得します。これには次の 2 つの方法があります。
    1. profileFilterLink リソースの list メソッドを実行し、プロファイル フィルタ リンクの ID を取得します。
    2. フィルタとビュー（旧プロファイル）の両方の ID がわかっている場合、これら 2 つの ID をコロンでつないでプロファイル フィルタ リンクの ID を取得することもできます。たとえば、ビュー ID が 1234 で、フィルタ ID が 5678 の場合、プロファイル フィルタ リンクの ID は 1234:5678 となります。
  3. profileFilterLink リソースの delete メソッドを実行してフィルタを削除します。

詳細については、API リファレンスの profileFilterLink リソースの delete メソッドの説明をご覧ください。

ビュー（旧プロファイル）に対するフィルタの優先順位の変更

デフォルトでは、フィルタは追加された順序でビュー（旧プロファイル）に適用されます。フィルタの順序を変更する手順は次のとおりです。

  1. Management API か管理画面を使って、フィルタを削除するアカウント ID、プロパティ ID、ビュー ID（旧プロファイル ID）を取得します。
  2. ビューから削除するプロファイル フィルタ リンクの ID を取得します。これには次の 2 つの方法があります。
    1. profileFilterLink リソースの list メソッドを実行し、プロファイル フィルタ リンクの ID を取得します。
    2. フィルタとビュー（旧プロファイル）の両方の ID がわかっている場合、これら 2 つの ID をコロンでつないでプロファイル フィルタ リンクの ID を取得することもできます。たとえば、ビュー ID が 1234 で、フィルタ ID が 5678 の場合、プロファイル フィルタ リンクの ID は 1234:5678 となります。
  3. profileFilterLink リソースの patch メソッドを実行してフィルタの順序を変更します。

詳細については、API リファレンスに記載された profileFilterLink リソースの patch メソッドの説明をご覧ください。

サンプルコード

filters リソースを使用すると、認証済みユーザーはフィルタを一覧表示、取得、更新、挿入することができます。フィルタにパッチを適用することも可能です。さらに、profileFilterLinks リソースを使用すると、認証済みユーザーはプロファイル フィルタ リンクを一覧表示、取得、更新、挿入することができます。プロファイス フィルタ リンクにパッチを適用することも可能です。これらのメソッドを使用するには、準備セクションの説明に従い、まず Analytics サービス オブジェクトを作成する必要があります。

フィルタとプロファイル フィルタ リンク リソースを扱う例を示すサンプルコードについては、以下のメソッド リファレンスをご覧ください。

フィルタの管理

  • list - ユーザーがアクセスできるフィルタを一覧表示します。
  • get - ユーザーがアクセスできるフィルタを取得します。
  • insert - 新しいフィルタを作成します。
  • patch - 既存のフィルタにパッチを適用します。
  • update - 既存のフィルタを更新します。

フィルタリンクの管理

  • list - ユーザーがアクセスできるプロファイル フィルタ リンクを一覧表示します。
  • get - ユーザーがアクセスできるプロファイル フィルタ リンクを取得します。
  • insert - 新しいプロファイル フィルタ リンクを作成します。
  • patch - 既存のプロファイル フィルタ リンクにパッチを適用します。
  • update - 既存のプロファイル フィルタ リンクを更新します。