- 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à 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à một ứ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: 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 các trường hợp 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: 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 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. 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. Thông tin đầu vào 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 không gian trong các điều kiện sau:
Đối với không gian hiện có, trường này chỉ có đầu ra. |
spaceThreadingState |
Chỉ có đầu ra. Trạng thái chuỗi tin nhắn trong không gian Chat. |
spaceDetails |
Không bắt buộc. Thông tin chi tiết về không gian, bao gồm cả 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 cho 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, thời gian không gian được tạo. Trường này chỉ có thể xuất, ngoại trừ khi đượ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 để giữ nguyên thời gian tạo ban đầu. Chỉ được điền sẵn trong kết quả 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, liệu 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ợ quản trị viên cài đặt, ứ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. |
sessionState |
Chỉ có đầu ra. Trạng thái phiên của không gian. |
sessionEnableTime |
Chỉ có đầu ra. Dấu thời gian khi trạng thái hỗ trợ phiên của không gian chuyển thành được hỗ trợ. Không đặt nếu không gian không bật tính năng hỗ trợ phiên. |
importModeExpireTime |
Chỉ có đầu ra. Thời điể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 không gian bằng phương thức xác thực ứng dụng và Ở định dạng Trường này không được điền sẵn cho tin nhắn trực tiếp (DM) hoặc khi không gian do người dùng không sử dụng Google Workspace tạo. |
Đại diện cho bộ quyền của một không gian. Chỉ được điền sẵn khi space_type là SPACE. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: |
|
predefinedPermissionSettings |
Không bắt buộc. Chỉ có đầu vào. Chế độ cài đặt bộ quyền 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 vào trường Việc đặt bộ quyền được xác định trước sẽ hỗ trợ:
|
permissionSettings |
Không bắt buộc. Chế độ cài đặt bộ quyền cho không gian hiện có. Thông tin đầu vào để cập nhật bộ quyền chính xác trong không gian, trong đó bộ quyền hiện tại sẽ được thay thế. Kết quả 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ợ:
|
| Kết thúc các trường loại trừ lẫn nhau. | |
Loại
Không dùng nữa: 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 người dùng và ứng dụng Chat, trong đó tất cả tin nhắn đều không theo chuỗi. 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 các trường hợp 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 hoặc giữa một người và một ứng dụng Chat. |
SpaceThreadingState
Chỉ định loại trạng thái chuỗi tin nhắn trong không gian trên Chat.
| Enum | |
|---|---|
SPACE_THREADING_STATE_UNSPECIFIED |
Đã đặt trước. |
THREADED_MESSAGES |
Không gian 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 tin nhắn để giữ cho câu trả lời của họ nằm trong ngữ cảnh của tin nhắn gốc. |
GROUPED_MESSAGES |
Không gian có tên riêng, trong đó cuộc trò chuyện được sắp xếp theo chủ đề. Các chủ đề và câu trả lời sẽ được nhóm lại với nhau. |
UNTHREADED_MESSAGES |
Không gian không hỗ trợ tính năng tạo chuỗi tin nhắn. Trạng thái phân luồng này của không gian chỉ được dùng cho các trường hợp đặc biệt, bao gồm:
|
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, mục đích hoạt động hoặc người tham gia của không gian. Hỗ trợ tối đa 4.096 ký tự. |
guidelines |
Không bắt buộc. Quy tắc, kỳ vọng và phép lịch sự trong 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 |
Nhật ký đang tắt. 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 thời gian lưu giữ tin nhắn và chuỗi tin nhắn. |
MembershipCount
Cho biết 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 đã 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 trở thành 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 đã trực tiếp tham gia 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 tin nhắn trong không gian. Nếu bạn không đặt chế độ này, thì chỉ những người dùng hoặc 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 Đọc các đối tượng mục tiêu được hỗ trợ:
Trường này không được điền sẵn khi sử dụng phạm vi Để đặt đối tượng mục tiêu, bạn cần xác thực người dùng. |
accessPermissionSettings |
Không bắt buộc. Truy cập vào phần cài đặt quyền cho không gian. Để đặt đối tượng mục tiêu khi tạo không gian, hãy chỉ định trường |
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 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 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. Người dùng hoặc Nhóm Google đã được thêm hoặc mời riêng lẻ vào không gian 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 Giúp người dùng cụ thể tìm thấy không gian. Để tạo không gian mở, bạn cần xác thực người dùng. |
AccessPermissionSettings
Truy cập vào phần cài đặt bộ quyền cho một không gian.
| Biểu diễn dưới dạng JSON |
|---|
{ "discoverSpaceSetting": { object ( |
| Trường | |
|---|---|
discoverSpaceSetting |
Không bắt buộc. Chế độ cài đặt bộ quyền để khám phá không gian. |
joinSpaceSetting |
Không bắt buộc. Chế độ cài đặt bộ quyền truy cập để tham gia không gian. |
viewSpaceMembershipSetting |
Không bắt buộc. Chế độ cài đặt quyền truy cập để xem danh sách thành viên của không gian. Phải được chỉ định cùng với |
AccessPermissionSetting
Chế độ cài đặt quyền truy cập.
| Biểu diễn dưới dạng JSON |
|---|
{
"principals": [
{
object ( |
| Trường | |
|---|---|
principals[] |
Không bắt buộc. Danh sách không theo thứ tự. Các đối tượng chính được phép sử dụng quyền này. |
Tổng
Một đối tượng chính đại diện cho một thực thể được cấp quyền truy cập.
| Biểu diễn dưới dạng JSON |
|---|
{
"audience": {
object ( |
| Trường | |
|---|---|
| Loại đối tượng chính. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi: | |
audience |
Đối tượng. |
| Kết thúc các trường loại trừ lẫn nhau. | |
Đối tượng
Đối tượng mục tiêu trong Google Chat. Đối tượng mục tiêu là một nhóm người dùng trong một tổ chức Google Workspace, do quản trị viên xác định. Đối tượng mục tiêu được dùng để định cấu hình chế độ cài đặt quyền truy cập và chế độ hiển thị cho tài nguyên, chẳng hạn như cho phép một nhóm người dùng cụ thể tìm thấy một không gian.
Để biết thêm thông tin, hãy xem bài viết Đối tượng mục tiêu và Giúp đối tượng mục tiêu có thể khám phá không gian.
| Biểu diễn dưới dạng JSON |
|---|
{ "name": string } |
| Trường | |
|---|---|
name |
Tên tài nguyên của đối tượng mục tiêu có thể khám phá hoặc tham gia 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 |
PredefinedPermissionSettings
Chế độ cài đặt quyền được xác định trước mà bạn chỉ có thể chỉ định khi tạo không gian có 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 bài viết Tìm hiểu về không gian.
| Enum | |
|---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED |
Không xác định. Đừng sử dụng. |
COLLABORATION_SPACE |
Chế độ cài đặt để đặt 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 để đặt 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
Bộ 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ó.
Để thiết lập bộ 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 |
Không bắt buộc. Chế độ cài đặt để quản lý thành viên và nhóm trong 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ý không gian. |
useAtMentionAll |
Không bắt buộc. Chế độ cài đặt để sử dụng @all trong một không gian. |
manageApps |
Không bắt buộc. Chế độ cài đặt để quản lý ứng dụng trong không gian. |
manageWebhooks |
Không bắt buộc. 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 |
Không bắt buộc. Chế độ cài đặt để trả lời tin nhắn trong không gian. |
viewSpaceMembership |
Không bắt buộc. Chế độ cài đặt để xem danh sách thành viên trong không gian. Phải được chỉ định cùng với |
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, "assistantManagersAllowed": boolean } |
| Trường | |
|---|---|
managersAllowed |
Không bắt buộc. Chủ sở hữu không gian ( |
membersAllowed |
Không bắt buộc. Liệu thành viên cơ bản trong không gian ( |
assistantManagersAllowed |
Không bắt buộc. Liệu người quản lý không gian |
SpaceSessionState
Trạng thái phiên của không gian.
| Enum | |
|---|---|
SPACE_SESSION_STATE_UNSPECIFIED |
Không xác định. Đừng sử dụng. |
NOT_SUPPORTED |
Không gian không hỗ trợ phiên. |
THREAD |
Không gian hỗ trợ phiên dựa trên chuỗi tin nhắn. |
Phương thức |
|
|---|---|
|
Hoàn tất quy trình nhập cho không gian được chỉ định và cho phép người dùng nhìn thấy không gian đó. |
|
Tạo không gian. |
|
Xoá một không gian có 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ề tất cả không gian có spaceType == GROUP_CHAT, có thành viên là người dùng chứa chính xác người dùng đang gọi và người dùng được chỉ định trong FindGroupChatsRequest.users. |
|
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 không gian. |
|
Trả về danh sách không gian trong một tổ chức trên Google Workspace. |
|
Tạo không gian và thêm người dùng được chỉ định vào không gian đó. |