REST Resource: users.availability

资源：可用性

表示用户在 Google Chat 中的当前状态信息，包括状态（例如“在线”“离开”“勿扰”）和任何自定义状态。

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

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
字段
name

string

标识符。用户的空闲时间的资源名称。

格式：users/{user}/availability

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

用户的电子邮件地址或 me 也可用作别名来指代调用者。例如 users/user@example.com 或 users/me。
state

enum (State)

仅限输出。用户的当前空闲状态。
customStatus

object (CustomStatus)

可选。用户的自定义状态。
联合字段 state_metadata。与用户的空闲状态相关联的其他元数据。state_metadata 只能是下列其中一项：
doNotDisturbMetadata

object (DoNotDisturbMetadata)

仅限输出。如果用户状态设置为“请勿打扰”，则为元数据。

州

表示用户的当前空闲状态。

枚举
STATE_UNSPECIFIED 默认值。状态未指定。
ACTIVE 用户目前处于活跃状态（根据近期活动判断）。
IDLE 用户目前处于空闲状态。此状态表示从有效状态到可能过渡到离开状态之间的一段不活动时间。
AWAY 用户目前不在。此模式可以是在设备处于有效或空闲状态一段时间后自动设置的，也可以由用户手动设置。通过 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

 更新人工客服的空闲情况信息。