配置合作伙伴控制的帐号 – API 开发者指南

简介

createAccountTree 是 Provisioning API 的一部分，可用于大规模创建新的 Google Analytics（分析）帐号。与 createAccountTicket 不同，createAccountTree 不需要任何最终用户互动即可完成账号的创建，整个流程是完全自动化的。如果您需要配置代表客户控制的 Google Analytics（分析）账号以及向客户提供数据的自定义视图，此功能会非常有用。

此 API 专供控制着用户网站或网络媒体资源的合作伙伴使用。如果您的用户自行控制自己的网站或网络媒体资源，则您应改为创建用户控制的 Google Analytics（分析）帐号。

开始之前

所有 Google Analytics（分析）API 的访问方法都基本相同。在开始使用 Provisioning API 之前，您应该：

访问客户端库页面，查看与该 API 配合使用的编程语言客户端库的完整列表。
参阅参考指南，熟悉该 API 的界面，并了解如何在没有客户端库的情况下访问数据。

每个客户端库提供单个分析服务对象来访问 Provisioning API。要创建服务对象，您通常需要完成以下步骤：

在 Google API 控制台中注册您的应用。
授权创建新的 Google Analytics（分析）账号。
创建 Google Analytics（分析）服务对象。

如果您尚未完成上述步骤，请停止操作，并阅读 Google Analytics（分析）API 入门教程。此教程将会向您逐一介绍构建 Google Analytics（分析）API 应用的初始步骤。完成此教程后，您将了解如何访问 Google Analytics（分析）API 执行实际任务。

模板账号

为了获得使用此 API 的授权，您需要提供一个新的 Google Analytics（分析）帐号，作为此 API 的模板帐号。新创建的帐号会继承模板帐号的各种设置，包括服务条款接受者、组织和各种数据共享设置。如需详细了解模板帐号，包括所有继承数据的列表，请参阅 createAccountTree 参考文档。

配置账号

若要配置新的 Google Analytics（分析）账号，请向 createAccountTree API 端点发出请求。您将需要以下详细配置信息：

帐号字段
- 帐号的 accountName。
网络媒体资源字段
- 属性的 webpropertyName。
- 一个 websiteUrl。应是此 Google Analytics（分析）账号的用户媒体资源所关联的网址。
数据视图字段
- 视图的 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 Analytics（分析）账号，均由通过 OAuth 对响应进行授权的用户账号所拥有。因此，在管理 Google Analytics（分析）账号时，我们建议您的组织使用服务账号，而不是单个用户账号。

创建帐号后，您可以使用 Management API 对其进行配置。以下是新建帐号的一些常见任务：

账号关系说明

与所有 Google API 一样，您需要有一个 Google Cloud 项目作为请求授权的起点。如 OAuth 2.0 文档中所述，此账号是您管理 API 请求凭据的地方。但是，创建的 Google Analytics（分析）帐号与 Cloud 项目或其管理帐号没有任何直接关联，而仅与授权请求的用户或服务帐号关联。如果您需要配置对 Google Analytics（分析）帐号的帐号访问权限，可以使用 Management API。