Method: users.availability.markAsDoNotDisturb

在 Google Chat 中將使用者標示為 DO_NOT_DISTURB。

將使用者的可用狀態設為 DO_NOT_DISTURB，直到指定到期時間為止。使用者通常不會在 DO_NOT_DISTURB 模式下收到通知。

這個方法只會更新通過驗證的使用者是否可預約。

需要使用者驗證，並提供授權範圍：

  • https://www.googleapis.com/auth/chat.users.availability

HTTP 要求

POST https://chat.googleapis.com/v1/{name=users/*/availability}:markAsDoNotDisturb

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

必填。要標示為「零打擾」的空房資訊資源名稱。格式：users/{user}/availability

{user} 是 People API 或 Admin SDK Directory API 中 Person 的 ID。例如：users/123456789。

使用者的電子郵件地址或 me 也可做為別名，用來指稱來電者。例如 users/user@example.com 或 users/me。

要求主體

要求主體會包含結構如下的資料：

JSON 表示法 
{

  "expireTime": string,
  "ttl": string
}
欄位
必填。請勿打擾狀態的有效期限。訂閱到期後，系統會將使用者標示為「離開」。最多可延長 1 年 (從目前時間算起)。以下列出互斥的欄位。回應中最多會設定一個欄位：
expireTime

string (Timestamp format)

「請勿打擾」狀態到期的絕對時間戳記。
ttl

string (Duration format)

從目前時間到「請勿打擾」狀態到期的時間長度。
互斥欄位的結尾。

回應主體

如果成功，回應主體會包含 Availability 的執行個體。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/chat.users.availability

詳情請參閱授權指南。