- Tài nguyên: Không gian
- Phương thức
Tài nguyên: Không gian
Một không gian trong Google Chat. Không gian là các 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à một ứng dụng trong 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 Trong đó |
type |
Chỉ có đầu ra. Không dùng nữa: Chuyển sang 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ỉ 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 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: Chuyển sang dùng |
displayName |
Tên hiển thị của không gian. Bắt buộc khi tạo không gian bằng Đố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. 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. Nhập dữ liệu khi tạo không gian trong một tổ chức trên Google Workspace. Bỏ qua trường này khi tạo khoảng trắng trong các điều kiện sau:
Đối với không gian hiện có, trường này chỉ là dữ liệu đầu ra. |
spaceThreadingState |
Chỉ có đầu ra. Trạng thái tạo 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à quy tắc. |
spaceHistoryState |
Trạng thái nhật ký tin nhắn của 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. Thời gian tạo không gian đối với các không gian được tạo trong Chat. Trường này chỉ dành cho 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 tại thời điể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 vào kết quả 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 những không gian nhắn tin trực tiếp (DM) có ứng dụng Chat, thông tin 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ể 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 ứng dụng 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 hội 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 khi |
spaceUri |
Chỉ có đầu ra. URI để người dùng truy cập vào không gian. |
Trường kết hợp space_permission_settings . Đại diện cho các chế độ cài đặt quyền của một không gian. Chỉ được điền khi space_type là SPACE . space_permission_settings chỉ có thể là một trong những trạng thái sau đây: |
|
predefinedPermissionSettings |
Không bắt buộc. Chỉ nhập. Cài đặt quyền đối với không gian. Dữ liệu đầu vào để tạo không gian, không gian cộng tác sẽ được tạo nếu bạn không đặt trường này. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền sẵn vào trường |
permissionSettings |
Không bắt buộc. Có thể đặt đúng chế độ cài đặt quyền để cập nhật không gian. Mục nhập để cập nhật một không gian. Nếu không, chỉ có thể xuất đầu ra. Để tạo không gian, hãy sử dụng |
Loại
Không dùng nữa: Chuyển sang dùng SpaceType
.
Enum | |
---|---|
TYPE_UNSPECIFIED |
Đã đặt trước. |
ROOM |
Cuộc trò chuyện giữa hai hoặc nhiều người. |
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 cố định. 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 không gian. Chỉ có đầu ra cho mục đích sử dụng khác.
Enum | |
---|---|
SPACE_TYPE_UNSPECIFIED |
Đã đặt trước. |
SPACE |
Một 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 giữa 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 giữa một người và một ứng dụng trong Chat. |
SpaceThreadingState
Chỉ định loại trạng thái của chuỗi tin nhắn trong phòng Chat.
Enum | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Đã đặt trước. |
THREADED_MESSAGES |
Không gian được đặt tên có hỗ trợ các chuỗi tin nhắn. Khi trả lời thư, người dùng có thể trả lời dưới dạng chuỗi, tức là câu trả lời của họ vẫn nằm trong ngữ cảnh của thư gốc. |
GROUPED_MESSAGES |
Không gian có tên, trong đó cuộc trò chuyện được sắp xếp theo chủ đề. Các chủ đề và câu trả lời của chủ đề đượ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à 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ả không gian. Ví dụ: mô tả chủ đề thảo luận của không gian, mục đích chức năng hoặc người tham gia. Hỗ trợ tối đa 150 ký tự. |
guidelines |
Không bắt buộc. Quy tắc, yêu cầu 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 khoảng thời gian lưu giữ các tin nhắn và chuỗi 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ữ của Vault của tổ chức chỉ định khoảng thời gian lưu giữ thư và chuỗi. |
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 khi là thành viên trong một nhóm đã tham gia. |
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ể khám phá không gian, tham gia không gian và xem trước tin nhắn trong không gian. Nếu bạn không đặt chính sách này, thì chỉ những người dùng hoặc nhóm trên Google Groups đã được mời hoặc thêm riêng 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 Giúp đối tượng mục tiêu có thể 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 |
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 |
Chỉ những người dùng hoặc nhóm trên Google Groups mà quản trị viên Google Workspace hoặc người dùng khác thêm hoặc mời riêng mới có thể khám phá 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 trên Google Groups được thêm hoặc mời riêng vào không gian cũng có thể khám phá và truy cập vào không gian. Để tìm hiểu thêm, hãy xem bài viết Giúp người dùng cụ thể có thể tìm thấy không gian. |
PredefinedPermissionSettings
Chế độ cài đặt quyền của không gian mà bạn có thể chỉ định khi tạo không gian được đặt tên. Trong tương lai, chúng tôi có thể sẽ thêm các chế độ cài đặt khác. Để biết thông tin chi tiết về các chế độ cài đặt quyền cho không gian được đặt tên, hãy xem bài viết 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 mà 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, nơi chỉ người quản lý không gian mới có thể đăng tin nhắn. |
PermissionSettings
Cài đặt quyền cho một không gian được đặt tên. Để thiết lập chế độ cài đặt quyền khi tạo 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 |
Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian. |
modifySpaceDetails |
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 |
Chế độ cài đặt để bật và tắt nhật ký của không gian. |
useAtMentionAll |
Chế độ cài đặt để sử dụng tính năng đề cập tất cả bằng @trong một không gian. |
manageApps |
Chế độ cài đặt để quản lý ứng dụng trong một không gian. |
manageWebhooks |
Chế độ cài đặt để quản lý webhook trong không gian. |
postMessages |
Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian. |
replyMessages |
Chế độ cài đặt để trả lời tin nhắn trong một không gian. |
PermissionSetting
Đại diện cho một chế độ cài đặt quyền của không gian.
Biểu diễn dưới dạng JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
Trường | |
---|---|
managersAllowed |
Việc người quản lý không gian có quyền này hay không. |
membersAllowed |
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 không gian được chỉ định và hiển thị không gian đó cho người dùng. |
|
Tạo không gian không có thành viên. |
|
Xoá một không gian đã đặ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ê các không gian mà phương thức gọi là thành viên. |
|
Cập nhật một không gian. |
|
|
|
Tạo một không gian và thêm những người dùng được chỉ định vào không gian đó. |