この API は非推奨で、Google アナリティクス 4（GA4）プロパティをサポートしていません。Admin API を使用して、GA4 プロパティのプロビジョニングと管理を行います。

このページは Cloud Translation API によって翻訳されました。

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

はじめに

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 を使用できます。