Management API - 目標に関するデベロッパー ガイド

このドキュメントでは、Management API を使って目標データにアクセスする方法について説明します。

はじめに

Google アナリティクスの目標は、アカウント階層の 4 つ目となる最下位レベルで、子エンティティはありません。目標リソースには、それぞれ 1 つのビュー(旧プロファイル)リソースが階層構造の親エンティティとして割り当てられています。

Management API で提供される目標データは、名前、値、タイプ、アクティブかどうかなど、目標の設定を表します。

作成できる各種目標データの詳細については、目標の設定についての記事(ヘルプセンター)をご覧ください。

準備

このガイドでは、次のプログラミング言語を使用して Google アナリティクスの API にアクセスする方法について説明します。
  • Java
  • Python
  • PHP

  • Management API で利用できるプログラミング言語ごとのクライアント ライブラリは、クライアント ライブラリ ページにまとめられています。
  • クライアント ライブラリを使用せずに API にアクセスする方法については、リファレンス ガイドをご覧ください。

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

  1. Google Developers Console でアプリケーションを登録します。
  2. Google アナリティクス データへのアクセスを承認します。
  3. 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 アナリティクス管理画面の [アナリティクス設定] ページで作成できます。

目標の制限事項と動作

目標のリソースには、以下の制限事項と動作が適用されます。

  • ビュー(旧プロファイル)あたり 20 件の目標と。ビュー(旧プロファイル)がこの上限に達すると、そのビュー(旧プロファイル)については、API で目標を追加作成できなくなります。ただし、既存の目標を更新して再利用することは可能です。制限事項全般については、制限と割り当てを参照してください。
  • 目標を削除することはできませんが、非アクティブにすることはできます。この場合、 active プロパティを False に設定します。目標が非アクティブになっている間、データは記録されませんが、過去のデータは使用することができます。

サンプルコード

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

目標リソースを扱う方法を示すサンプルコードについては、以下のメソッド リファレンスをご覧ください。

  • list - ユーザーがアクセスできる目標を一覧表示します。
  • get - ユーザーがアクセスできる目標を取得します。
  • insert - 新しい目標を作成します。
  • patch - 既存の目標をこうしします。このメソッドはパッチの動作をサポートしています。
  • update - 既存の目標を更新します。

サンプル アプリケーション

Management API ですべてのデータを走査してアクセスする方法の実際の例については、Management API リファレンスのサンプルをご覧ください。

Java


Google アナリティクス API の Java クライアント ライブラリ サンプル

Python


Google アナリティクス API の Python クライアント ライブラリ サンプル

PHP


Google アナリティクス API の PHP クライアント ライブラリ サンプル