REST Resource: spaces

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

  // 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

Tên tài nguyên của không gian.

Định dạng spaces/{space}
type
(deprecated)

enum (Type)

Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng spaceType. Loại không gian.
spaceType

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

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 một ứng dụng Chat và một người hay không.
threaded
(deprecated)

boolean

Chỉ có đầu ra. Không dùng nữa: Chuyển sang dùng spaceThreadingState. Liệu thư có được tạo chuỗi trong không gian này hay không.
displayName

string

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 ALREADY_EXISTS khi tạo 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 trên 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 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. 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:

  • 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 sẽ cho phép mọi người dùng Google Chat.

  • Không gian được dùng để nhập dữ liệu vào Google Chat vì không gian ở chế độ nhập chỉ được cho phép các thành viên thuộc cùng một tổ chức trên Google Workspace. Tuy nhiên, trong Chương trình dùng thử Google Workspace dành cho nhà phát triển, không gian ở chế độ nhập có thể cho phép mọi người dùng Google Chat. Sau đó, trường này có thể được thiết lập thành không gian ở chế độ nhập.

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

enum (SpaceThreadingState)

Chỉ có đầu ra. Trạng thái của chuỗi tin nhắn trong phòng Chat.
spaceDetails

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

enum (HistoryState)

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

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. Mặc dù không gian đang được nhập, người dùng sẽ không nhìn thấy chúng cho đến khi quá trình nhập hoàn tất.
createTime

string (Timestamp format)

Không bắt buộc. Không thể thay đổi. Thời gian tạo không gian đối với những 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 mà tại đó 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 kết quả khi spaceType là GROUP_CHAT hoặc SPACE.
lastActiveTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian của tin nhắn cuối cùng trong không gian.

adminInstalled

boolean

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

object (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 spaceType là SPACE, 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 khi spaceType là SPACE.

spaceUri

string

Chỉ có đầu ra. URI của 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

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

permissionSettings

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

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 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 các chủ đề đó sẽ đượ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

string

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

string

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 Nhật ký trò chuyện đ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 khoảng thời gian lưu giữ thư và chuỗi.

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

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 là thành viên trong một nhóm đã tham gia.
joinedGroupCount

integer

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 (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ể truy cập vào không gian. Đặt trường này thành một mã đối tượng mục tiêu hợp lệ để mọi người có thể tìm thấy không gian hoặc sử dụng đại diện audiences/default để thiết lập không gian bằng chế độ cài đặt quyền truy cập mặc định trong Bảng điều khiển dành cho quản trị viên. Để tìm hiểu thêm, 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. Huỷ thiết lập trường này để không gian bị hạn chế. Chỉ được điền sẵn khi không gian là không gian có thể tìm thấy. Định dạng: audiences/{audience}, bạn có thể dùng audiences/default làm bí danh của Chế độ cài đặt cách chia sẻ mặc định trong cuộc trò chuyệ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 Thành viên hoặc nhóm được thêm hoặc được mời có thể tìm thấy không gian.
DISCOVERABLE Đối tượng mục tiêu đã chọn cũng như thành viên hoặc nhóm đã thêm hoặc được mời 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 chuyể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 (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)

Chế độ cài đặt để quản lý thành viên và nhóm trong một không gian.
modifySpaceDetails

object (PermissionSetting)

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)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

Chế độ cài đặt để quản lý webhook trong 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)

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

boolean

Việc người quản lý không gian có quyền này hay không.
membersAllowed

boolean

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 không gian được chỉ định và hiển thị không gian đó cho người dùng.

create

 Tạo một không gian được đặt tên.

delete

 Xoá một không gian đã đặ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ê các không gian mà phương thức gọi là thành viên.

patch

 Cập nhật một không gian.

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