REST Resource: spaces

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 (Type),   "spaceType": enum (SpaceType),   "singleUserBotDm": boolean,   "threaded": boolean,   "displayName": string,   "externalUserAllowed": boolean,   "spaceThreadingState": enum (SpaceThreadingState),   "spaceDetails": {     object (SpaceDetails)   },   "spaceHistoryState": enum (HistoryState),   "importMode": boolean,   "createTime": string,   "lastActiveTime": string,   "adminInstalled": boolean,   "membershipCount": {     object (MembershipCount)   },   "accessSettings": {     object (AccessSettings)   },   "spaceUri": string,   "importModeExpireTime": string,   "customer": string,    // Union field space_permission_settings can be only one of the following:   "predefinedPermissionSettings": enum (PredefinedPermissionSettings),   "permissionSettings": {     object (PermissionSettings)   }   // End of list of possible types for union field space_permission_settings. }
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của không gian.

Định dạng spaces/{space}

Trong đó, {space} biểu thị mã nhận dạng do hệ thống chỉ định cho không gian. Bạn có thể lấy mã nhận dạng không gian bằng cách gọi phương thức spaces.list() hoặc từ URL của không gian. Ví dụ: nếu URL của không gian là https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, thì mã nhận dạng không gian là AAAAAAAAA.

type
(deprecated)

enum (Type)

Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy sử dụng spaceType. Loại không gian.

spaceType

enum (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

boolean

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
(deprecated)

boolean

Chỉ có đầu ra. Không dùng nữa: Thay vào đó, hãy sử dụng spaceThreadingState. Tin nhắn có được sắp xếp theo chuỗi trong không gian này hay không.

displayName

string

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 gianspaceTypeSPACE. Nếu bạn nhận được thông báo lỗi ALREADY_EXISTS khi tạo một không gian hoặc cập nhật displayName, hãy thử một displayName khác. Một không gian hiện có trong tổ chức Google Workspace có thể đã sử dụng tên hiển thị này.

Đố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

boolean

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:

  • Người dùng đã xác thực sử dụng tài khoản người dùng cá nhân (tài khoản người dùng không được quản lý). Theo mặc định, không gian do tài khoản người dùng cá nhân tạo cho phép mọi người dùng Google Chat.

Đối với các không gian hiện có, trường này chỉ có đầu ra.

spaceThreadingState

enum (SpaceThreadingState)

Chỉ có đầu ra. Trạng thái theo chuỗi trong phòng Chat.

spaceDetails

object (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

enum (HistoryState)

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

boolean

Không bắt buộc. Liệu không gian này có được tạo trong Import Mode trong quá trình di chuyển dữ liệu sang Google Workspace hay không. Trong quá trình nhập, người dùng sẽ không nhìn thấy không gian cho đến khi quá trình nhập hoàn tất.

Để tạo không gian trong Import Mode, bạn cần phải xác thực người dùng.

createTime

string (Timestamp format)

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 spaceTypeGROUP_CHAT hoặc SPACE.

lastActiveTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian của tin nhắn gần đây nhất trong không gian.

adminInstalled

boolean

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

object (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 spaceTypeSPACE, DIRECT_MESSAGE hoặc GROUP_CHAT.

accessSettings

object (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 spaceTypeSPACE.

spaceUri

string

Chỉ có đầu ra. URI để người dùng truy cập vào không gian.

importModeExpireTime

string (Timestamp format)

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 spaces.completeImport.

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

string

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ụngSpaceTypeSPACE, nếu không thì bạn không nên đặt.

Theo định dạng customers/{customer}, trong đó customerid từ tài nguyên khách hàng Admin SDK. Các ứng dụng riêng tư cũng có thể sử dụng bí danh customers/my_customer để tạo không gian trong cùng một tổ chức Google Workspace với ứng 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_typeSPACE. space_permission_settings chỉ có thể là một trong những trạng thái sau:
predefinedPermissionSettings

enum (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 PermissionSettings.

Việc đặt chế độ cài đặt quyền được xác định trước sẽ hỗ trợ:

permissionSettings

object (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

string

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

string

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

integer

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

integer

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 (AccessState),   "audience": string }
Trường
accessState

enum (AccessState)

Chỉ có đầu ra. Cho biết trạng thái truy cập của không gian.

audience

string

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 audiences/{audience}

Để sử dụng đối tượng mục tiêu mặc định cho tổ chức Google Workspace, hãy đặt thành audiences/default.

Đọ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 chat.bot với xác thực ứng dụng.

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 (PermissionSetting)   },   "modifySpaceDetails": {     object (PermissionSetting)   },   "toggleHistory": {     object (PermissionSetting)   },   "useAtMentionAll": {     object (PermissionSetting)   },   "manageApps": {     object (PermissionSetting)   },   "manageWebhooks": {     object (PermissionSetting)   },   "postMessages": {     object (PermissionSetting)   },   "replyMessages": {     object (PermissionSetting)   } }
Trường
manageMembersAndGroups

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Không bắt buộc. Chế độ cài đặt để bật và tắt nhật ký của không gian.

useAtMentionAll

object (PermissionSetting)

Không bắt buộc. Chế độ cài đặt để sử dụng @tất cả trong một không gian.

manageApps

object (PermissionSetting)

Không bắt buộc. Chế độ cài đặt để quản lý ứng dụng trong một không gian.

manageWebhooks

object (PermissionSetting)

Không bắt buộc. Chế độ cài đặt để quản lý webhook trong một không gian.

postMessages

object (PermissionSetting)

Chỉ có đầu ra. Chế độ cài đặt để đăng tin nhắn trong không gian.

replyMessages

object (PermissionSetting)

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

boolean

Không bắt buộc. Người quản lý không gian có quyền này hay không.

membersAllowed

boolean

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

completeImport

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 đó.

create

Tạo một không gian.

delete

Xoá một không gian được đặt tên.

findDirectMessage

Trả về tin nhắn trực tiếp hiện có với người dùng được chỉ định.

get

Trả về thông tin chi tiết về một không gian.

list

Liệt kê những không gian mà người gọi là thành viên.

patch

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.

setup

Tạo một không gian và thêm những người dùng được chỉ định vào không gian đó.