Management API -“过滤器”开发者指南

本文介绍了如何使用 Management API 来为授权用户管理 Google Analytics（分析）过滤器。

简介

Management API 中的过滤器功能让您可以创建、获取、列出、更新用于您的 Google Analytics（分析）帐户的过滤器，并确定要将哪些过滤器应用于数据视图（配置文件）和进行管理。要详细了解过滤器的工作原理，请参阅关于视图过滤器（帮助中心）

Management API 中的两项资源实现了过滤器管理的自动化。

  1. “过滤器”资源，代表 Google Analytics（分析）中的某个过滤器及其配置。一个“过滤器”资源集合代表与某个 Google Analytics（分析）帐户相关联的所有过滤器。
  2. “配置文件过滤器关联”资源，代表过滤器与作为其应用对象的数据视图（配置文件）之间的关联。一个“配置文件过滤器关联”集合代表目前应用到某个数据视图（配置文件）的所有过滤器。

开始之前

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

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

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

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

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

使用情形

通过使用 Management API 中的过滤器，可以将多个帐户的最佳做法集中起来，并实现应用和移除现有过滤器的自动化。例如：

创建一个采用预定义配置/标准配置的过滤器

要创建一个采用预定义配置的新过滤器，请按以下步骤操作：

  1. 使用 Management API 或网络界面获取要添加新过滤器的帐户的 Id。
  2. 采用预定义配置，并执行 filter 资源的 insert 方法。

请参阅 API 参考，详细了解 filter 资源的 insert 方法。

要将过滤器应用到某个数据视图（配置文件），请按以下步骤操作：

  1. 使用 Management API 或网络界面获取过滤器所属帐户的 Id。
  2. 通过执行 filter 资源的 list 方法，或者执行 filter 资源的 get 方法（如果您知道 Filter Id），获取要应用到数据视图（配置文件）的过滤器资源。
  3. 使用 Management API 或网络界面获取 Account Id、Property Id 以及要应用过滤器的数据视图（配置文件）的 Id。
  4. 通过执行 profileFilterLink 资源的 insert 方法应用该过滤器。

请参阅 API 参考，详细了解 profileFilterLink 资源的 insert 方法。

要取消过滤器与数据视图（配置文件）的关联，请按以下步骤操作：

  1. 使用 Management API 或网络界面获取 Account Id、Property Id 以及要移除过滤器的数据视图（配置文件）的 Id。
  2. 获取要从该数据视图中移除的“配置文件过滤器关联”的 Id。可以采取以下两种方法：
    1. 执行 profileFilterLink 资源的 list 方法，并获取“配置文件过滤器关联”的 Id。
    2. 如果您知道过滤器 Id 和数据视图（配置文件）Id，将它们用冒号连接起来，就是“配置文件过滤器关联”的 Id。例如，假设数据视图 Id 是 1234，过滤器 Id 是 5678，则“配置文件过滤器关联”的 Id 就是 1234:5678。
  3. 通过执行 profileFilterLink 资源的 delete 方法移除过滤器。

请参阅 API 参考，详细了解 profileFilterLink 资源的 delete 方法。

更改数据视图（配置文件）过滤器的排名顺序

默认情况下，过滤器按照它们的添加顺序应用到数据视图（配置文件）。要更改过滤器的顺序，请按以下步骤操作：

  1. 使用 Management API 或网络界面获取 Account Id、Property Id 以及要移除过滤器的数据视图（配置文件）的 Id。
  2. 获取要从该数据视图中移除的“配置文件过滤器关联”的 Id。可以采取以下两种方法：
    1. 执行 profileFilterLink 资源的 list 方法，并获取“配置文件过滤器关联”的 Id。
    2. 如果您知道过滤器 Id 和数据视图（配置文件）Id，将它们用冒号连接起来，就是“配置文件过滤器关联”的 Id。例如，假设数据视图 Id 是 1234，过滤器 Id 是 5678，则“配置文件过滤器关联”的 Id 就是 1234:5678。
  3. 通过执行 profileFilterLink 资源的 patch 方法，更改该过滤器的排序。

请参阅 API 参考，详细了解 profileFilterLink 资源的 patch 方法。

代码示例

filters 资源让授权用户可以列出、获取、更新、修补和插入过滤器。profileFilterLinks 资源让授权用户可以列出、获取、更新、修补和插入配置文件过滤器关联。要进行这些操作，您首先需要创建一个 Analytics 服务对象，如开始之前部分所述。

要查看代码示例，了解如何使用“过滤器”和“配置文件过滤器关联”资源，请访问下面的方法参考：

管理过滤器

  • list — 列出用户有访问权限的过滤器。
  • get — 获取用户有访问权限的过滤器。
  • insert — 创建一个新过滤器。
  • patch — 修补现有过滤器。
  • update — 更新现有过滤器。

管理过滤器关联

  • list — 列出用户有访问权限的配置文件过滤器关联。
  • get — 获取用户有访问权限的配置文件过滤器关联。
  • insert — 插入新的配置文件过滤器关联。
  • patch — 修补现有的配置文件过滤器关联。
  • update — 更新现有的配置文件过滤器关联。