User Deletion API - 概览

本文档简要介绍了 Google Analytics（分析）User Deletion API。

简介

借助 Google Analytics（分析）User Deletion API，客户可以处理与指定用户标识符关联的数据删除。此工具是可用于帮助您保护数据的几种工具之一。

概览

借助 User Deletion API，Google Analytics（分析）客户可以从项目或网站媒体资源中删除指定用户标识符的数据。可以使用 Firebase 项目或 Google Analytics（分析）媒体资源发出用户删除请求。

请求删除数据

使用 upsert 方法请求删除指定用户的数据。upsert 方法将用户删除请求资源作为其唯一参数。数据删除请求可应用于 Google Analytics（分析）网站媒体资源（由 webPropertyId 字段指定）或 GA4 媒体资源（由 propertyId 字段指定）。可以通过在 id.userId 字段中设置其中一个标识符来指定删除其数据的用户。必须在 id.type 字段内指定标识符的类型。支持的 User ID 类型：

  • CLIENT_ID：Google Analytics（分析）客户端 ID（仅当设置了 webPropertyId 或 propertyId 字段时才支持）。webPropertyIdwebPropertyId
  • USER_ID：Google Analytics（分析）User ID（仅当设置了 webPropertyId 或 propertyId 字段时才支持）。webPropertyIdwebPropertyId
  • APP_INSTANCE_ID：Firebase 应用实例 ID（仅当设置了 firebaseProjectId 或 属性 ID 字段时才支持）。firebaseProjectIdfirebaseProjectId

如需详细了解 User ID 和 Client ID 功能，请访问 Google Analytics（分析）帮助中心。

数据删除

upsert 方法会返回用户删除请求资源，并设置 deletionRequestTime 字段。deletionRequestTime 字段用于标记 Google Analytics（分析）收到删除请求的时间点。

调用 upsert 方法需要 https://www.googleapis.com/auth/analytics.user.deletion OAuth 2.0 范围。