パートナー管理アカウントのプロビジョニング - API デベロッパー ガイド

はじめに

createAccountTree は Provisioning API の一部で、新しい Google アナリティクス アカウントの作成を大規模に行うために使用します。createAccountTicket とは異なり、createAccountTree ではアカウントの作成にエンドユーザーとのやりとりは必要なく、プロセスは完全に自動化されています。この手法は、顧客に代わって管理するアナリティクス アカウントをプロビジョニングし、そのデータのカスタムビューを顧客に提供したい場合に便利です。

この API は、ユーザーのウェブサイトやウェブ プロパティを管理するパートナー専用のものです。ユーザーが独自のウェブサイトやウェブ プロパティを管理している場合は、代わりにユーザー管理のアナリティクス アカウントを作成する必要があります。

準備

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

  • API で利用可能なすべてのプログラミング言語ごとのクライアント ライブラリの一覧を、クライアント ライブラリ ページで確認する。
  • API インターフェースの詳細と、クライアント ライブラリを使わずにデータにアクセスする方法をリファレンス ガイドで確認する。

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

  1. お使いのアプリケーションを Google API コンソールで登録します。
  2. 新しい Google アナリティクス アカウントの作成を承認します。
  3. Analytics サービス オブジェクトを作成します。

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

テンプレート アカウント

この API を使用するにはホワイトリストに登録される必要がありますが、その際にはこの API のテンプレート アカウントとして機能する新しい Google アナリティクス アカウントを設定しなければなりません。プロビジョニングで作成される新しいアカウントは、利用規約の同意、組織データ共有設定など、さまざまな設定をテンプレート アカウントから継承します。テンプレート アカウントの詳細および継承されるデータの一覧については、createAccountTree リファレンスをご覧ください。

アカウントのプロビジョニング

新しい Google アナリティクス アカウントをプロビジョニングするには、createAccountTree API エンドポイントにリクエストを行います。リクエストを行うには、次のプロビジョニング情報が必要です。

  • アカウントに関するフィールド
    • accountName - アカウント名。
  • ウェブ プロパティに関するフィールド
    • webpropertyName - プロパティ名。
    • websiteUrl - ウェブサイトの URL。このアナリティクス アカウントのユーザー プロパティに関連付けられた 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 アナリティクス アカウントは、クラウド プロジェクトやその管理アカウントには直接関連していません。このアカウントが関連付けられているのは、リクエストを承認したユーザー アカウントまたはサービス アカウントのみです。アナリティクス アカウントへのアクセス権の設定は、Management API から行うことができます。