Method: properties.submitUserDeletion

提交针对媒体资源的删除用户数据请求。

HTTP 请求

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要提交用户删除请求的媒体资源的名称。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{

  // Union field user can be only one of the following:
  "userId": string,
  "clientId": string,
  "appInstanceId": string,
  "userProvidedData": string
  // End of list of possible types for union field user.
}
字段
联合字段 user。提交删除请求的用户 user 只能是以下用户之一：
userId

string

Google Analytics 用户 ID。
clientId

string

Google Analytics 客户端 ID。
appInstanceId

string

Firebase 应用实例 ID。
userProvidedData

string

用户提供的数据。可以包含一个电子邮件地址或一个电话号码。

电子邮件地址应按如下方式进行规范化：

  • 小写
  • 针对 gmail.com/googlemail.com 地址，移除 @ 前面的句点
  • 移除所有空格

电话号码应按如下方式进行规范化：

  • 移除所有非数字字符
  • 添加“+”前缀

响应正文

针对 properties.submitUserDeletion RPC 的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "deletionRequestTime": string
}
字段
deletionRequestTime

string (Timestamp format)

标记一个时间点，该时间点之前的所有访问者数据都应被删除。此属性设置为收到删除请求的时间。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/analytics.edit