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

使用者提供的資料。可包含一個電子郵件地址或一個電話號碼。

電子郵件地址應經過正規化，如下所示：

  • lowercase
  • 移除 gmail.com/googlemail.com 地址中「@」前的半形句號
  • 移除所有空格

電話號碼應標準化為：

  • 移除所有非數字字元
  • 新增「+」前置字元

回應主體

屬性專用的 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