REST Resource: users.availability

資源：Availability

代表使用者在 Google Chat 中的目前狀態資訊，包括狀態 (例如「線上」、「離開」、「請勿打擾」) 和任何自訂狀態。

JSON 表示法 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
欄位
name

string

ID。使用者可用性的資源名稱。

格式：users/{user}/availability

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

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

enum (State)

僅供輸出。使用者目前的空閒狀態。
customStatus

object (CustomStatus)

(選用步驟) 使用者的自訂狀態。
聯集欄位 state_metadata。與使用者有空與否狀態相關的其他中繼資料。state_metadata 只能是下列其中一項：
doNotDisturbMetadata

object (DoNotDisturbMetadata)

僅供輸出。如果使用者狀態設為「DO_NOT_DISTURB」，則為中繼資料。

州

代表使用者的目前供應情形狀態。

列舉
STATE_UNSPECIFIED 預設值。未指定狀態。
ACTIVE 根據最近的活動，使用者目前處於活躍狀態。
IDLE 使用者目前處於閒置狀態。這個狀態表示在「ACTIVE」之後，可能轉換為「AWAY」之前的閒置期。
AWAY 使用者目前不在。系統會在「ACTIVE」或「IDLE」狀態下閒置一段時間後自動設定，使用者也可以手動設定。透過 availability.markAsAway 手動設定時，無論使用者活動為何，這個狀態都會持續存在。
DO_NOT_DISTURB 使用者處於手動設定的「零干擾」狀態。

DoNotDisturbMetadata

與 DO_NOT_DISTURB 供應情形狀態相關聯的中繼資料，用於指定狀態的到期時間。

JSON 表示法 
{
  "expirationTime": string
}
欄位
expirationTime

string (Timestamp format)

僅供輸出。使用者應標示為「請勿打擾」的時間戳記。最多可設為未來 1 年內的日期。

CustomStatus

代表 Google Chat 中使用者的自訂狀態。包括簡短的訊息 (可選擇加入表情符號)，使用者可設定這類訊息，提供更多有關自己空閒時間的背景資訊。

JSON 表示法 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
欄位
text

string

必填。自訂狀態的文字。長度上限為 64 的字串。
emoji

object (Emoji)

必填。自訂狀態的表情符號。系統僅支援 Unicode 表情符號，不支援自訂表情符號。
聯集欄位 expiration。自訂狀態的到期時間。可以指定為絕對時間戳記或存留時間長度。expiration 只能是下列其中一項：
expireTime

string (Timestamp format)

自訂狀態到期的時間戳記。
ttl

string (Duration format)

僅供輸入。自訂狀態到期前的存留時間長度。

方法

get

 傳回 Google Chat 中真人使用者的有空與否資訊。

markAsActive

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

markAsAway

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

markAsDoNotDisturb

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

patch

 更新真人使用者的有空與否資訊。