REST Resource: users.availability

Tài nguyên: Phạm vi cung cấp

Biểu thị thông tin hiện tại về trạng thái hoạt động của người dùng trong Google Chat, bao gồm cả trạng thái của họ (ví dụ: Đang hoạt động, Vắng mặt, Không làm phiền) và mọi trạng thái tuỳ chỉnh.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "state": enum (State),
  "customStatus": {
    object (CustomStatus)
  },

  "doNotDisturbMetadata": {
    object (DoNotDisturbMetadata)
  }
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên về tình trạng còn phòng của người dùng.

Định dạng users/{user}/availability

{user} là mã nhận dạng của Người dùng trong People API hoặc Admin SDK Directory API. Ví dụ: users/123456789.

Địa chỉ email hoặc me của người dùng cũng có thể được dùng làm tên thay thế để chỉ người gọi. Ví dụ: users/user@example.com hoặc users/me
state

enum (State)

Chỉ có đầu ra. Trạng thái hiện tại của người dùng.
customStatus

object (CustomStatus)

Không bắt buộc. Trạng thái tuỳ chỉnh của người dùng.
Trường nhóm state_metadata. Siêu dữ liệu bổ sung liên kết với trạng thái rảnh/bận của người dùng. state_metadata chỉ có thể là một trong những trạng thái sau:
doNotDisturbMetadata

object (DoNotDisturbMetadata)

Chỉ có đầu ra. Siêu dữ liệu nếu trạng thái người dùng được đặt thành DO_NOT_DISTURB.

Tiểu bang

Biểu thị trạng thái hiện tại về khả năng sử dụng của người dùng.

Enum
STATE_UNSPECIFIED Giá trị mặc định. Tiểu bang không được chỉ định.
ACTIVE Người dùng hiện đang hoạt động, dựa trên hoạt động gần đây.
IDLE Người dùng hiện đang ở trạng thái rảnh. Trạng thái này cho biết một khoảng thời gian không hoạt động sau khi ở trạng thái ĐANG HOẠT ĐỘNG, trước khi có thể chuyển sang trạng thái KHÔNG HOẠT ĐỘNG.
AWAY Người dùng hiện đang vắng mặt. Bạn có thể đặt trạng thái này tự động sau một khoảng thời gian không hoạt động ở trạng thái ĐANG HOẠT ĐỘNG hoặc KHÔNG HOẠT ĐỘNG, hoặc người dùng có thể đặt trạng thái này theo cách thủ công. Khi được đặt theo cách thủ công thông qua availability.markAsAway, trạng thái này sẽ duy trì bất kể hoạt động của người dùng.
DO_NOT_DISTURB Người dùng đang ở trạng thái Không làm phiền (được đặt theo cách thủ công).

DoNotDisturbMetadata

Siêu dữ liệu liên kết với trạng thái còn hàng DO_NOT_DISTURB, cho biết thời điểm trạng thái được đặt là hết hạn.

Biểu diễn dưới dạng JSON 
{
  "expirationTime": string
}
Trường
expirationTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian cho đến khi người dùng được đánh dấu là KHÔNG_LÀM_PHIỀN. Ngày này có thể cách thời điểm hiện tại tối đa 1 năm.

CustomStatus

Biểu thị trạng thái tuỳ chỉnh của người dùng trong Google Chat. Trong đó có một tin nhắn văn bản ngắn (có thể kèm theo biểu tượng cảm xúc) do người dùng đặt để cung cấp thêm thông tin về trạng thái rảnh/bận của họ.

Biểu diễn dưới dạng JSON 
{
  "text": string,
  "emoji": {
    object (Emoji)
  },

  "expireTime": string,
  "ttl": string
}
Trường
text

string

Bắt buộc. Văn bản của trạng thái tuỳ chỉnh. Đây sẽ là một chuỗi có độ dài tối đa là 64.
emoji

object (Emoji)

Bắt buộc. Biểu tượng cảm xúc của trạng thái tuỳ chỉnh. Chỉ hỗ trợ biểu tượng cảm xúc Unicode; không hỗ trợ biểu tượng cảm xúc tuỳ chỉnh.
Trường nhóm expiration. Thời gian hết hạn của trạng thái tuỳ chỉnh. Bạn có thể chỉ định giá trị này dưới dạng dấu thời gian tuyệt đối hoặc khoảng thời gian tồn tại. expiration chỉ có thể là một trong những trạng thái sau:
expireTime

string (Timestamp format)

Dấu thời gian khi trạng thái tuỳ chỉnh hết hạn.
ttl

string (Duration format)

Chỉ có đầu vào. Thời gian tồn tại mà sau đó trạng thái tuỳ chỉnh sẽ hết hạn.

Phương thức

get

 Trả về thông tin về trạng thái hoạt động của người dùng là con người trong Google Chat.

markAsActive

 Đánh dấu người dùng là ACTIVE trong Google Chat.

markAsAway

 Đánh dấu người dùng là AWAY trong Google Chat.

markAsDoNotDisturb

 Đánh dấu người dùng làDO_NOT_DISTURB trong Google Chat.

patch

 Cập nhật thông tin về tình trạng rảnh/bận của người dùng là con người.