Management API - ウェブ プロパティに関するデベロッパー ガイド

このドキュメントでは、Management API を使ってウェブ プロパティのデータにアクセスする方法について説明します。

はじめに

Google アナリティクスのウェブ プロパティは、アカウント階層構造の第 2 レベルのエンティティです。各ウェブ プロパティには、単一のアカウント リソースが親エンティティとして割り当てられています。また、1 つまたは複数のビューのリソースのコレクションが子エンティティとして割り当てられています。

• ウェブ プロパティと他の Management API エンティティの関係については、Management API の概要ガイドでエンティティの概要をご覧ください。
• ウェブ プロパティに関する一般的な情報については、アカウントとビュー（旧プロファイル）のコンセプト ガイドをご覧ください。

すべてのデータ収集はウェブ プロパティ単位で実行されるため、Google アナリティクスのウェブ プロパティは重要です。たとえば、ウェブサイトかモバイルアプリにトラッキング コードを追加する場合は、UA-xxxxx-y のような ID を含める必要があります。この ID はウェブ プロパティ ID と呼ばれ、Google アナリティクス アカウントのデータの格納場所を識別します。

準備

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

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

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

上記の手順を完了していない場合は、まず Google Analytics API についてのチュートリアルをご覧ください。このチュートリアルでは、Google Analytics API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、このガイドを使用して実環境で作業できるようになります。

次のコード スニペットは、手順 3（Analytics サービス オブジェクトの作成）の続きであり、承認済みのサービス オブジェクトを格納する変数が含まれます。

Analytics analytics = // Read Hello Analytics Tutorial for details.

analytics = # Read Hello Analytics Tutorial for details.

$client = // Read Hello Analytics Tutorial for details.

// Return results as objects.
$client->setUseObjects(true);

$analytics = new apiAnalyticsService($client);

Analytics サービス オブジェクトを作成すれば、Management API にリクエストを送信するための準備は完了です。

注: この Analytics サービス オブジェクトを使用して Core Reporting API にアクセスすることもできます。

テスト アカウントの使用

Management API を使ってプロパティを作成、設定する場合は、テスト アカウントでコードを実装して検証することをおすすめします。テスト アカウントを使うことで、アクティブなプロパティを誤って変更されないようにすることができます。テスト アカウントとプロパティを使ってコードをテストし、コードが期待どおりに動作していることを確認できたら、実際のアカウントでコードを実装できるようになります。

テスト アカウントは、Google アナリティクス管理画面の [アナリティクス設定] ページで作成できます。

サンプルコード

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

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

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

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

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