Management API -“数据视图(配置文件)”开发者指南

本文介绍了如何使用 Management API 来访问“数据视图(配置文件)”数据。

简介

Google Analytics(分析)的“数据视图(配置文件)”资源处于帐户层级结构的第三级。每个数据视图(配置文件)有一个“网络媒体资源”资源作为它在层级结构中的父级,并且可以有一个子级,该子级由零个或多个“目标”资源组成。

  • 请阅读 Management API 概览指南中的实体概览,了解数据视图(配置文件)与其他 Management API 实体之间的关系。
  • 请阅读帐户和数据视图(配置文件)概念性指南,了解关于数据视图(配置文件)的一般信息。

Google Analytics(分析)的“数据视图(配置文件)”很重要,因为所有报告都在这一层级完成。当您查询 Core Reporting API 时,您必须在每个 ids 查询中指定一个 Table ID 参数,以确定要从哪个数据视图(配置文件)访问数据。Table ID 参数在每个“数据视图(配置文件)”资源中返回。

开始之前

本指南说明了如何使用以下编程语言来访问 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

使用测试帐户

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

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

“数据视图(配置文件)”的限制和操作

以下限制和操作适用于“数据视图(配置文件)”资源:

  • 默认的上限是每个媒体资源 25 个数据视图。您可以与您的 Google 帐户经理联系,将非 premium 版和 premium 版媒体资源的数据视图上限分别提高到 200 个和 400 个。如果某个帐户达到此上限,则无法再通过该 API 创建更多数据视图(配置文件),除非删除现有的一个或多个数据视图(配置文件)。此外,可以更新和重复使用现有的数据视图(配置文件)。请参阅限制和配额,了解一般的限制有哪些。

代码示例

Management API 让您可以为授权用户列出、获取、插入、更新、修补和删除数据视图(配置文件)。要进行这些操作,您首先需要创建一个 Analytics 服务对象,如开始之前部分所述。

要查看代码示例,了解如何使用“数据视图(配置文件)”资源,请访问下面的方法参考:

  • list — 列出用户有访问权限的数据视图(配置文件)。
  • get — 获取用户有访问权限的数据视图(配置文件)。
  • insert — 创建一个新的数据视图(配置文件)。
  • patch — 更新现有的数据视图(配置文件)。此方法支持修补语义。
  • update — 更新现有的数据视图(配置文件)。
  • delete — 删除数据视图(配置文件)。

示例应用

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

Java


Google Analytics(分析)API Java 客户端库示例

Python


Google Analytics(分析)API Python 客户端库示例

PHP


Google Analytics(分析)API PHP 客户端库示例