- Tài nguyên: Space
- Phương thức
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 hoặc nhiều người dùng hoặc tin nhắn 1:1 giữa người dùng và ứng dụng Chat.
Biểu diễn dưới dạng JSON |
---|
{ "name": string, "type": enum ( |
Trường | |
---|---|
name |
Giá trị nhận dạng. Tên tài nguyên của không gian. Định dạng Trong đó, |
type |
Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy sử dụng |
spaceType |
Không bắt buộc. 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 một không gian. Chỉ có đầu ra 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 ứng dụng Chat và một người dùng hay không. |
threaded |
Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy sử dụng |
displayName |
Không bắt buộc. Tên hiển thị của không gian. Bắt buộc khi tạo một không gian có Đố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 bắt buộc. Không thể thay đổi. Không gian này có cho phép mọi người dùng Google Chat làm thành viên hay không. Thông tin đầu vào khi tạo không gian trong một tổ chức Google Workspace. Bỏ qua trường này khi tạo không gian trong các điều kiện sau:
Đối với các không gian hiện có, trường này chỉ có đầu ra. |
spaceThreadingState |
Chỉ có đầu ra. Trạng thái theo chuỗi trong phòng Chat. |
spaceDetails |
Không bắt buộc. Thông tin chi tiết về không gian, bao gồm nội dung mô tả và quy tắc. |
spaceHistoryState |
Không bắt buộc. 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 Để tạo không gian trong |
createTime |
Không bắt buộc. Không thể thay đổi. Đối với không gian được tạo trong Chat, đây là thời gian tạo không gian. Trường này chỉ có đầu ra, trừ trường hợp được dùng trong các không gian ở chế độ nhập. Đối với các không gian ở chế độ nhập, hãy đặt trường này thành dấu thời gian trong quá khứ mà không gian được tạo trong nguồn để giữ nguyên thời gian tạo ban đầu. Chỉ được điền sẵn trong đầu ra khi |
lastActiveTime |
Chỉ có đầu ra. Dấu thời gian của tin nhắn gần đây nhất trong không gian. |
adminInstalled |
Chỉ có đầu ra. Đối với không gian tin nhắn trực tiếp (DM) có ứng dụng Chat, cho biết 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ể cài đặt và thiết lập tin nhắn trực tiếp với một ứng dụng Chat thay cho người dùng trong tổ chức của họ. Để hỗ trợ tính năng cài đặt của quản trị viên, ứng dụng Chat của bạn phải có tính năng nhắn tin trực tiếp. |
membershipCount |
Chỉ có đầu ra. Số lượng gói thành viên đã tham gia, được nhóm theo loại 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 sẵn khi |
spaceUri |
Chỉ có đầu ra. URI để người dùng truy cập vào không gian. |
importModeExpireTime |
Chỉ có đầu ra. Thời gian mà hệ thống sẽ tự động xoá không gian nếu không gian đó vẫn ở chế độ nhập. Mỗi không gian được tạo ở chế độ nhập phải thoát khỏi chế độ này trước thời gian hết hạn bằng cách sử dụng Trường này chỉ được điền sẵn cho những không gian được tạo bằng chế độ nhập. |
customer |
Không bắt buộc. Không thể thay đổi. Mã khách hàng của miền của không gian. Chỉ bắt buộc khi tạo một không gian có xác thực ứng dụng và Theo định dạng Đối với DM, trường này không được điền sẵn. |
Trường nhóm space_permission_settings . Đại diện cho chế độ cài đặt quyền của một không gian. Chỉ được điền sẵn khi space_type là SPACE . space_permission_settings chỉ có thể là một trong những trạng thái sau: | |
predefinedPermissionSettings |
Không bắt buộc. Chỉ có đầu vào. Chế độ cài đặt quyền đối với không gian được xác định trước, chỉ nhập khi tạo không gian. Nếu bạn không đặt trường này, một không gian cộng tác sẽ được tạo. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn trong trường Việc đặt chế độ cài đặt quyền được xác định trước sẽ hỗ trợ:
|
permissionSettings |
Không bắt buộc. Chế độ cài đặt quyền truy cập vào không gian đối với các không gian hiện có. Đầu vào để cập nhật chế độ cài đặt quyền truy cập chính xác vào không gian, trong đó chế độ cài đặt quyền hiện có sẽ được thay thế. Kết quả xuất ra sẽ liệt kê các chế độ cài đặt quyền hiện tại. Việc đọc và cập nhật chế độ cài đặt quyền hỗ trợ:
|
Loại
Không dùng nữa: Thay vào đó, hãy sử 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 một người dùng và một ứng dụng Chat, trong đó tất cả tin nhắn đều ở dạng phẳng. Xin lưu ý rằng điều 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 một không gian. Chỉ có đầu ra 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 Chat. |
GROUP_CHAT | Cuộc trò chuyện nhóm giữa 3 người trở lên. GROUP_CHAT có thể bao gồm các ứng dụng Chat. |
DIRECT_MESSAGE | Tin nhắn 1:1 giữa hai người dùng hoặc giữa một người dùng và một ứng dụng Chat. |
SpaceThreadingState
Chỉ định loại trạng thái phân luồng trong không gian trên Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED | Đã đặt trước. |
THREADED_MESSAGES | Không gian được đặt tên có hỗ trợ chuỗi tin nhắn. Khi trả lời một tin nhắn, người dùng có thể trả lời trong chuỗi để giữ phản hồi của họ trong ngữ cảnh của tin nhắn ban đầu. |
GROUPED_MESSAGES | Không gian có 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 của chủ đề đó sẽ được nhóm lại với nhau. |
UNTHREADED_MESSAGES | Tin nhắn trực tiếp (DM) giữa hai 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 nội dung mô tả và 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à phép tắ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. Xác định khoảng 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 | Nhật ký trò chuyện đang tắt. Tin nhắn và chuỗi cuộc trò chuyện sẽ được lưu giữ trong 24 giờ. |
HISTORY_ON | Nhật ký trò chuyện đã bật. Quy tắc lưu giữ của 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 thị số lượng thành viên của một không gian, được nhóm thành các danh mục.
Biểu diễn dưới dạng JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
Trường | |
---|---|
joinedDirectHumanUserCount |
Chỉ có đầu ra. Số lượng người dùng là con người đã trực tiếp tham gia không gian, không tính những người dùng tham gia bằng cách là thành viên của một nhóm đã tham gia. |
joinedGroupCount |
Chỉ có đầu ra. Số lượng tất cả các nhóm đã tham gia trực tiếp vào không gian. |
AccessSettings
Biểu thị 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ể khám phá không gian, tham gia không gian và xem trước các tin nhắn trong không gian. Nếu bạn không đặt chế độ này, chỉ những người dùng hoặc nhóm trên Google Groups được mời hoặc thêm riêng lẻ vào không gian mới có thể truy cập vào không gian đó. Để biết thông tin chi tiết, hãy xem bài viết Cho phép đối tượng mục tiêu tìm thấy không gian. Định dạng Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành Đọc đối tượng mục tiêu hỗ trợ:
Trường này không được điền khi sử dụng phạm vi Bạn cần phải xác thực người dùng để đặt đối tượng mục tiêu. |
AccessState
Biểu thị trạng thái truy cập của không gian.
Enum | |
---|---|
ACCESS_STATE_UNSPECIFIED | Không xác định được trạng thái truy cập hoặc trạng thái này không được hỗ trợ trong API này. |
PRIVATE | Chỉ những người dùng hoặc Nhóm Google được người dùng khác hoặc quản trị viên Google Workspace thêm hoặc mời riêng lẻ mới có thể tìm thấy và truy cập vào không gian. |
DISCOVERABLE | Người quản lý không gian đã cấp cho một đối tượng mục tiêu quyền truy cập vào không gian. Những người dùng hoặc Nhóm Google được thêm hoặc mời vào không gian theo cách riêng lẻ cũng có thể tìm thấy và truy cập vào không gian. Để tìm hiểu thêm, hãy xem bài viết Cho phép một số người dùng tìm thấy không gian. Để tạo không gian mở, bạn cần phải xác thực người dùng. |
PredefinedPermissionSettings
Chế độ cài đặt quyền được xác định trước mà bạn chỉ có thể chỉ định khi tạo một không gian được đặt tên. Các chế độ cài đặt khác có thể sẽ được thêm vào trong tương lai. Để biết thông tin chi tiết về chế độ cài đặt quyền cho không gian có tên, hãy xem phần Tìm hiểu về không gian.
Enum | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED | Không xác định. Không sử dụng. |
COLLABORATION_SPACE | Chế độ cài đặt để biến không gian thành không gian cộng tác, nơi tất cả thành viên đều có thể đăng tin nhắn. |
ANNOUNCEMENT_SPACE | Chế độ cài đặt để biến không gian thành không gian thông báo, trong đó chỉ người quản lý không gian mới có thể đăng tin nhắn. |
PermissionSettings
Chế độ cài đặt quyền mà bạn có thể chỉ định khi cập nhật một không gian có tên hiện có.
Để đặt chế độ cài đặt quyền khi tạo một không gian, hãy chỉ định trường PredefinedPermissionSettings
trong yêu cầu của bạn.
Biểu diễn dưới dạng JSON |
---|
{ "manageMembersAndGroups": { object ( |
Trường | |
---|---|
manageMembersAndGroups |
Không bắt buộc. Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian. |
modifySpaceDetails |
Không bắt buộc. Chế độ cài đặt để cập nhật tên, hình đại diện, nội dung mô tả và nguyên tắc của không gian. |
toggleHistory |
Không bắt buộc. Chế độ cài đặt để bật và tắt nhật ký của không gian. |
useAtMentionAll |
Không bắt buộc. Chế độ cài đặt để sử dụng @tất cả trong một không gian. |
manageApps |
Không bắt buộc. Chế độ cài đặt để quản lý ứng dụng trong một không gian. |
manageWebhooks |
Không bắt buộc. Chế độ cài đặt để quản lý webhook trong một không gian. |
postMessages |
Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian. |
replyMessages |
Không bắt buộc. Chế độ cài đặt để trả lời tin nhắn trong không gian. |
PermissionSetting
Đại diện cho chế độ cài đặt quyền trong không gian.
Biểu diễn dưới dạng JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
Trường | |
---|---|
managersAllowed |
Không bắt buộc. Người quản lý không gian có quyền này hay không. |
membersAllowed |
Không bắt buộc. Liệu các thành viên không phải là người quản lý có quyền này hay không. |
Phương thức | |
---|---|
| Hoàn tất quy trình nhập cho không gian đã chỉ định và cho phép người dùng nhìn thấy không gian đó. |
| Tạo một không gian. |
| Xoá một 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 được chỉ định. |
| Trả về thông tin chi tiết về một không gian. |
| Liệt kê những không gian mà người gọi là thành viên. |
| Cập nhật một không gian. |
| Trả về danh sách các không gian trong một tổ chức Google Workspace dựa trên nội dung tìm kiếm của quản trị viên. |
| Tạo một không gian và thêm những người dùng được chỉ định vào không gian đó. |