Management API -“帐户摘要”开发者指南

本文介绍了如何使用 Management API 在收到单一而快速的请求后，为授权用户列出有关 Google Analytics（分析）帐户、媒体资源和数据视图（配置文件）的简明信息。

简介

Management API 中的“帐户摘要”资源针对授权用户有访问权限的每个帐户、媒体资源和数据视图（配置文件）提供相关信息的简明摘要。

通过向 Management API 发出单个请求，便可获取帐户摘要。您可以使用摘要信息进行以下操作：

  • 构建自定义d帐户/媒体资源/数据视图（配置文件）选择器。要查看示例，请参阅查询浏览器。
  • 快速遍历帐户层级结构，确定父子关系。例如，可以获取用来发出 Core Reporting API 查询的数据视图（配置文件）Id，或者找出某个媒体资源或数据视图（配置文件）属于哪个帐户。

请参阅 API 参考，了解如何向 Management API 查询帐户摘要，并且请参阅 实体概览，概要了解各个 Management API 实体之间的关系。

开始之前

本指南说明了如何使用以下编程语言来访问 Google Analytics（分析）API：
  • Java
  • Python
  • PHP

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

每个客户端库提供单个 Analytics 服务对象来访问所有的 Management API 数据。要创建服务对象，您通常需要完成以下步骤：

  1. 在 Google Developers Console 中注册您的应用。
  2. 授予访问 Google Analytics（分析）数据的权限。
  3. 创建一个 Analytics 服务对象。

如果您未能完成上述步骤，请停止操作，并阅读 Google Analytics（分析）API 入门教程。该教程将为您详细介绍构建 Google Analytics（分析）API 应用的最初几个步骤。完成这些步骤后，您就可以使用本指南执行实际任务了。

以下代码段从第 3 步（创建一个 Analytics 服务对象）继续，包含一个用来存储已获授权的服务对象的变量。

Java

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

Python

analytics = # Read Hello Analytics Tutorial for details.

PHP

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

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

$analytics = new apiAnalyticsService($client);

PHP 库会将所有 API 结果作为一个关联数组来返回。要返回真正的对象，您可以调用客户端 useObject 方法，如上例所示。

创建了 Analytics 服务对象后，您就可以对 Management API 发出请求了。

备注：同一个 Analytics 服务对象也可以用来访问 Core Reporting API。

帐户摘要与帐户/媒体资源/配置文件的 List 方法对比

当您使用帐户、网络媒体资源和数据视图（配置文件）这些资源的 list 方法时，该 API 将返回每项相应资源的完整详细信息。而如果您查询帐户摘要，对于所有帐户、媒体资源和数据视图（配置文件），该 API 将返回上述信息的一个子集。

查询帐户摘要的好处是，此请求在许多使用情形下都更有效率，响应更迅速，而且只需单个请求您就能获得关于用户的整个帐户层级结构的信息。然后，如果您需要了解特定媒体资源或数据视图（配置文件）的详细信息，您可以利用相应资源的 get 方法来快速检索单个实体。

使用情形和示例

帐户摘要可用于实现以下示例中的使用情形：

  • 构建数据视图（配置文件）选择器。
  • 快速查找帐户、媒体资源和数据视图（配置文件）。例如，找出某个媒体资源属于哪个帐户，或者获取数据视图（配置文件）的名称。

构建数据视图（配置文件）选择器

与 Google Analytics（分析）整合的应用通常会为用户提供一个界面来选择帐户、媒体资源和数据视图（配置文件）。通过帐户摘要，您可以获取所有相关信息，以构建单个 Management API 请求中的数据视图（配置文件）选择器。

要查看示例，请参阅帐户摘要选择器示例 (GitHub)。

快速查找帐户、媒体资源和数据视图（配置文件）

您可以利用帐户摘要响应来构建帐户层级结构的索引。此索引可以用来快速查找帐户、媒体资源和数据视图的详细信息。然后，如果您需要某个实体的完整信息，可以对 Management API 发出附加调用，获取特定帐户、媒体资源或数据视图（配置文件）。

要查看示例，了解如何构建帐户树状视图和索引，请参阅帐户摘要树状视图/索引示例 (GitHib)。

代码示例

Management API 让您可以列出授权用户的所有帐户摘要。要列出帐户摘要，您首先需要创建一个 Analytics 服务对象，如开始之前部分所述。

要查看代码示例，了解如何使用“帐户摘要”资源，请参阅 list 方法参考中的示例。