Tài nguyên: Không gian
Một không gian trong Google Chat. Không gian là cuộc trò chuyện giữa hai người dùng trở lên hoặc tin nhắn 1:1 giữa một người dùng với một ứng dụng Chat.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "type": enum ( |
Trường | |
---|---|
name |
Tên tài nguyên của không gian. Định dạng |
type |
Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy dùng |
spaceType |
Loại không gian. Bắt buộc khi tạo không gian hoặc cập nhật loại không gian của không gian. Chỉ xuất dữ liệu cho mục đích sử dụng khác. |
singleUserBotDm |
Không bắt buộc. Liệu không gian có phải là tin nhắn trực tiếp giữa một ứng dụng Chat và một người hay không. |
threaded |
Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy dùng |
displayName |
Tên hiển thị của không gian. Bắt buộc khi tạo không gian. Nếu bạn nhận được thông báo lỗi Đối với tin nhắn trực tiếp, trường này có thể trống. Hỗ trợ tối đa 128 ký tự. |
externalUserAllowed |
Không thể thay đổi. Liệu không gian này có cho phép bất kỳ người dùng Google Chat nào làm thành viên hay không. Dữ liệu đầu vào khi tạo không gian trong tổ chức trên Google Workspace. Bỏ qua trường này khi tạo dấu cách trong các điều kiện sau:
Đối với các không gian hiện có, trường này chỉ dành cho kết quả đầu ra. |
spaceThreadingState |
Chỉ có đầu ra. Trạng thái chuỗi tin nhắn trong phòng Chat. |
spaceDetails |
Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và các quy tắc. |
spaceHistoryState |
Trạng thái nhật ký tin nhắn của các tin nhắn và chuỗi tin nhắn trong không gian này. |
importMode |
Không bắt buộc. Liệu không gian này có được tạo trong |
createTime |
Không bắt buộc. Không thể thay đổi. Đối với các không gian được tạo trong Chat, thời gian được tạo không gian. Trường này chỉ là kết quả đầu ra, trừ phi được dùng trong không gian ở chế độ nhập. Đối với không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trước đây mà không gian được tạo trong nguồn để duy trì thời gian tạo ban đầu. Chỉ được điền sẵn vào dữ liệu đầu ra khi |
lastActiveTime |
Chỉ có đầu ra. Dấu thời gian của tin nhắn cuối cùng trong không gian. |
adminInstalled |
Chỉ có đầu ra. Đối với không gian nhắn tin trực tiếp (DM) có ứng dụng Chat, việc không gian đó có phải do quản trị viên Google Workspace tạo hay không. Quản trị viên có thể thay mặt người dùng trong tổ chức cài đặt và thiết lập tin nhắn trực tiếp bằng ứng dụng Chat. Để hỗ trợ việc cài đặt bằng quyền quản trị, ứng dụng Chat phải có tính năng nhắn tin trực tiếp. |
membershipCount |
Chỉ có đầu ra. Số lượng hội viên đã tham gia được nhóm theo kiểu thành viên. Được điền sẵn khi |
accessSettings |
Không bắt buộc. Chỉ định chế độ cài đặt quyền truy cập của không gian. Chỉ được điền khi |
spaceUri |
Chỉ có đầu ra. URI của không gian. |
Loại
Không dùng nữa: Thay vào đó, hãy dùng SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Đã đặt trước. |
ROOM |
Cuộc trò chuyện giữa hai người trở lên. |
DM |
Tin nhắn trực tiếp 1:1 giữa người dùng và ứng dụng Chat, trong đó tất cả tin nhắn đều ở dạng phẳng. Xin lưu ý rằng trường hợp này không bao gồm tin nhắn trực tiếp giữa hai người. |
SpaceType
Loại không gian. Bắt buộc khi tạo hoặc cập nhật không gian. Chỉ xuất dữ liệu cho mục đích sử dụng khác.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Đã đặt trước. |
SPACE |
Nơi mọi người gửi tin nhắn, chia sẻ tệp và cộng tác. SPACE có thể bao gồm các ứng dụng trong Chat. |
GROUP_CHAT |
Cuộc trò chuyện nhóm có từ 3 người trở lên. GROUP_CHAT có thể bao gồm các ứng dụng trong Chat. |
DIRECT_MESSAGE |
Tin nhắn 1:1 giữa hai người hoặc một người với một ứng dụng Chat. |
SpaceThreadingState
Chỉ định loại trạng thái chuỗi trong phòng Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Đã đặt trước. |
THREADED_MESSAGES |
Không gian được đặt tên hỗ trợ chuỗi tin nhắn. Khi người dùng trả lời một tin nhắn, họ có thể trả lời trong chuỗi tin nhắn, nhờ đó giữ câu trả lời của họ trong ngữ cảnh của tin nhắn gốc. |
GROUPED_MESSAGES |
Không gian được đặt tên nơi cuộc trò chuyện được sắp xếp theo chủ đề. Các chủ đề và câu trả lời tương ứng được nhóm lại với nhau. |
UNTHREADED_MESSAGES |
Tin nhắn trực tiếp (DM) giữa 2 người và cuộc trò chuyện nhóm giữa 3 người trở lên. |
SpaceDetails
Thông tin chi tiết về không gian, bao gồm cả nội dung mô tả và các quy tắc.
Biểu diễn dưới dạng JSON |
---|
{ "description": string, "guidelines": string } |
Trường | |
---|---|
description |
Không bắt buộc. Nội dung mô tả về không gian. Ví dụ: mô tả chủ đề thảo luận, mục đích chức năng hoặc người tham gia của không gian. Hỗ trợ tối đa 150 ký tự. |
guidelines |
Không bắt buộc. Các quy tắc, kỳ vọng và nghi thức của không gian. Hỗ trợ tối đa 5.000 ký tự. |
HistoryState
Trạng thái nhật ký của tin nhắn và không gian. Chỉ định thời gian lưu giữ tin nhắn và chuỗi cuộc trò chuyện sau khi tạo.
Enum | |
---|---|
HISTORY_STATE_UNSPECIFIED |
Giá trị mặc định. Không được dùng. |
HISTORY_OFF |
Tắt nhật ký. Tin nhắn và chuỗi tin nhắn được lưu giữ trong 24 giờ. |
HISTORY_ON |
Đã bật nhật ký. Quy tắc lưu giữ Vault của tổ chức chỉ định thời gian lưu giữ các tin nhắn và chuỗi tin nhắn. |
MembershipCount
Biểu diễn dưới dạng JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Trường | |
---|---|
joinedDirectHumanUserCount |
Số người dùng đã trực tiếp tham gia không gian, không tính số người dùng tham gia bằng cách trở thành thành viên trong một nhóm. |
joinedGroupCount |
Số lượng tất cả các nhóm đã trực tiếp tham gia không gian. |
AccessSettings
Đại diện cho chế độ cài đặt quyền truy cập của không gian.
Biểu diễn dưới dạng JSON |
---|
{
"accessState": enum ( |
Trường | |
---|---|
accessState |
Chỉ có đầu ra. Cho biết trạng thái truy cập của không gian. |
audience |
Không bắt buộc. Tên tài nguyên của đối tượng mục tiêu có thể truy cập vào không gian. Đặt trường này thành một mã nhận dạng đối tượng mục tiêu hợp lệ để giúp đối tượng mục tiêu có thể tìm thấy không gian đó hoặc sử dụng email đại diện |
AccessState
Biểu thị trạng thái truy cập của Không gian.
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED |
Trạng thái truy cập không xác định hoặc không được hỗ trợ trong API này. |
PRIVATE |
Những thành viên hoặc nhóm được thêm hoặc được mời đều có thể tìm thấy không gian. |
DISCOVERABLE |
Đối tượng mục tiêu đã chọn, cũng như các thành viên/nhóm đã thêm hoặc được mời đều có thể tìm thấy không gian. |
Phương thức |
|
---|---|
|
Hoàn tất quy trình nhập không gian được chỉ định và hiển thị không gian đó cho người dùng. |
|
Tạo một không gian được đặt tên. |
|
Xoá không gian được đặt tên. |
|
Trả về tin nhắn trực tiếp hiện có với người dùng đã chỉ định. |
|
Trả về thông tin chi tiết về một không gian. |
|
Liệt kê các không gian có thành viên của phương thức gọi. |
|
Cập nhật một không gian. |
|
|
|
Tạo không gian và thêm người dùng được chỉ định vào không gian đó. |