はじめに
createAccountTree
は Provisioning API の一部で、新しい Google アナリティクス アカウントを大規模に作成するために使用できます。createAccountTicket
とは異なり、createAccountTree
では、アカウントの作成を完了するためにエンドユーザーとのやり取りは必要ありません。プロセスは完全に自動化されています。この手法は、顧客に代わって管理するアナリティクス アカウントをプロビジョニングし、そのデータのカスタムビューを顧客に提供したい場合に便利です。
この API は、ユーザーのウェブサイトやウェブ プロパティを管理するパートナー専用のものです。ユーザーが独自のウェブサイトやウェブ プロパティを管理している場合は、代わりにユーザー管理のアナリティクス アカウントを作成してください。
準備
Google アナリティクス API はすべて同じ方法でアクセスできます。Provisioning API を使用する前に、次の準備をしてください。
- API で利用可能なすべてのプログラミング言語ごとのクライアント ライブラリの一覧を、クライアント ライブラリ ページで確認する。
- API インターフェースの詳細と、クライアント ライブラリを使わずにデータにアクセスする方法をリファレンス ガイドで確認する。
各クライアント ライブラリは、Provisioning API にアクセスするための単一の Analytics サービス オブジェクトを提供します。サービス オブジェクトを作成するには、通常、次の手順を踏む必要があります。
- お使いのアプリケーションを Google API コンソールで登録します。
- 新しい Google アナリティクス アカウントの作成を承認します。
- Analytics サービス オブジェクトを作成します。
上記の手順を完了していない場合は、まず Google アナリティクス API についてのチュートリアルをご覧ください。このチュートリアルでは、Google アナリティクス API アプリケーションを作成する基本的な手順を詳しく説明しています。この手順を完了すると、Google アナリティクス API を実際の作業に活用する方法を理解することができます。
テンプレート アカウント
この API の使用を承認するうえで、この API のテンプレート アカウントとして機能する新しい Google アナリティクス アカウントを指定する必要があります。新しいアカウントを作成する際には、利用規約の同意者、組織、さまざまなデータ共有設定など、さまざまな設定がテンプレート アカウントから継承されます。継承されるすべてのデータのリストなど、テンプレート アカウントの詳細については、createAccountTree
リファレンスをご覧ください。
アカウントのプロビジョニング
新しい Google アナリティクス アカウントをプロビジョニングするには、createAccountTree
API エンドポイントにリクエストを送信します。リクエストを行うには、次のプロビジョニング情報が必要です。
- アカウント フィールド
- アカウントの
accountName
。
- アカウントの
- ウェブ プロパティ フィールド
- プロパティの
webpropertyName
。 websiteUrl
。このアナリティクス アカウントのユーザー プロパティに関連付けられた URL を入力してください。
- プロパティの
- ビュー フィールド
- ビューの
profileName
。 - ビューの
timezone
。
- ビューの
詳細を入力したら、API エンドポイントへの認証された呼び出しを行います。
POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
"accountName": "Analytics Account",
"webpropertyName": "Default Property",
"profileName": "Default View",
"timezone": "America/Los_Angeles",
"websiteUrl": "www.example-pet-store.com",
}
成功すると、API から新しく作成されたアカウント、ウェブ プロパティ、ビューの詳細が返されます。
{
"account": {
"id": "999999999",
"name": "Analytics Account",
"created": "2018-03-16T23:35:20.699Z",
"updated": "2018-03-16T23:35:20.699Z",
...
},
"webproperty": {
"id": "UA-999999999-1",
"name": "Default Property",
"websiteUrl": "www.example-pet-store.com",
"created": "2018-03-16T23:35:20.699Z",
"updated": "2018-03-16T23:35:20.699Z",
...
},
"profile": {
"id": "999999999",
"name": "Default View",
"timezone": "America/Los_Angeles",
"created": "2018-03-16T23:35:20.699Z",
"updated": "2018-03-16T23:35:20.699Z",
...
},
...
}
アカウントの所有権と管理
作成した Google アナリティクス アカウントは、OAuth 経由で応答を承認したユーザー アカウントが所有者になります。このため、個々のユーザー アカウントではなく、サービス アカウントを使用してアナリティクス アカウントを管理することをおすすめします。
アカウントを作成したら、Management API でアカウントを構成できます。新しく作成したアカウントでの一般的なタスクは次のとおりです。
アカウントの関係性の明確化
他の Google API と同様に、リクエスト承認の出発点として Google クラウド プロジェクトが必要です。OAuth 2.0 のドキュメントに記載されているように、このアカウントでは API リクエストの認証情報を管理します。ただし、作成された Google アナリティクス アカウントは、Cloud プロジェクトまたはその管理アカウントとは直接関係していません。リクエストを承認したユーザーまたはサービス アカウントにのみ関連付けられます。アナリティクス アカウントへのアカウントへのアクセスを設定する必要がある場合は、Management API を使用できます。