Management API -“目标”开发者指南

本文介绍了如何使用 Management API 访问“目标”数据。

简介

Google Analytics（分析）的“目标”处于帐户层级结构的第四级，也是最低的一级；“目标”没有子实体。每个“目标”资源都有一个数据视图（配置文件）资源作为其在层级结构中的父级。

请阅读 Management API 概览指南中的实体概览，了解“目标”与其他 anagement API 实体之间的关系。
请阅读帐户和数据视图（配置文件）概念性指南，了解关于“目标”的一般信息。

Management API 提供的“目标”数据描述了目标的配置情况，即：目标的名称、价值、类型，以及目标是否有效。

要了解可以创建的不同目标类型，请阅读设置目标（帮助中心）。

开始之前

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

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

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

在 Google Developers Console 中注册您的应用。
授予访问 Google Analytics（分析）数据的权限。
创建一个 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。

使用测试帐户

如果您打算使用 Management API 来创建和/或配置“目标”，我们建议您通过测试帐户实现和验证您的代码。使用测试帐户可帮助您避免对某个有效的“目标”做出意外更改。在使用测试帐户和“目标”测试了您的代码，并确认这些代码运行正常后，您就可以开始在您的真实帐户中进行实施了。

您可以在 Google Analytics（分析）网络界面的 Admin 部分创建一个测试帐户。

“目标”资源的限制和操作

以下限制和操作适用于“目标”资源：

上限是每个数据视图（配置文件）20 个目标。如果某个数据视图（配置文件）达到此上限，则无法再通过该 API 为该数据视图（配置文件）创建更多目标。不过，可以更新和重复使用现有目标。请参阅限制和配额，了解一般的限制有哪些。
目标无法删除，但是可以通过将目标的 active 属性设置为 False 来将目标标记为无效。对于无效的目标，不会再记录任何数据，但还会提供历史数据。

代码示例

Management API 让您可以为授权用户列出、获取、插入、更新和修补目标。要进行这些操作，您首先需要创建一个 Analytics 服务对象，如开始之前部分所述。

要查看代码示例，了解如何使用“目标”资源，请访问下面的方法参考：

list — 列出用户有访问权限的目标。
get — 获取用户有访问权限的目标。
insert — 创建一个新目标。
patch — 更新现有目标。此方法支持修补语义。
update — 更新现有目标。

示例应用

请查看“Management API 参考示例”中列举的操作示例，了解如何遍历和访问 Management API 中的所有数据。

Java

Google Analytics（分析）API Java 客户端库示例

Python

Google Analytics（分析）API Python 客户端库示例

PHP

Google Analytics（分析）API PHP 客户端库示例