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 một 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} là mã nhận dạng do hệ thống chỉ định cho không gian. Bạn có thể lấy mã 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ã không gian sẽ là AAAAAAAAA.
type
(deprecated)

enum (Type)

Chỉ có đầu ra. Không dùng nữa: 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. Chỉ có đầu ra cho các 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 dùng hay không.
threaded
(deprecated)

boolean

Chỉ có đầu ra. Không dùng nữa: Hãy sử dụng spaceThreadingState. Liệu 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 không gian với spaceType là SPACE. 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 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 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 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, một 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 tham gia.

Đố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 tạo chuỗi tin nhắn trong không gian 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 cho 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 khi quá trình nhập diễn ra, người dùng sẽ không thấy các không gian đó cho đến khi quá trình nhập hoàn tất.

Bạn cần xác thực người dùng để tạo không gian trong Import Mode.
createTime

string (Timestamp format)

Không bắt buộc. Không thể thay đổi. Đối với những không gian được tạo trong Chat, thời gian tạo không gian. Trường này chỉ xuất, ngoại trừ khi được sử 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 trong 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 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, 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 tính năng tin nhắn trực tiếp bằng một ứng dụng Chat.

Để 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 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 sẵn khi spaceType là SPACE.
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 điểm hệ thống 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 không gian có xác thực ứng dụng và SpaceType là SPACE, nếu không thì không được đặt.

Ở định dạng customers/{customer}, trong đó customer là id từ [tài nguyên khách hàng SDK quản trị]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). Ứ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 tin nhắn trực tiếp, trường này không được điền sẵn.

Trường hợp hợp nhất space_permission_settings. Biểu thị chế độ cài đặt quyền của một không gian. Chỉ được điền sẵn khi space_type là SPACE.

Yêu cầu xác thực người dùng. space_permission_settings chỉ có thể là một trong những loại sau:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

Không bắt buộc. Chỉ nhập. Chế độ cài đặt quyền cho 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, hệ thống sẽ tạo một không gian cộng tác. Sau khi bạn tạo không gian, các chế độ cài đặt sẽ được điền vào trường PermissionSettings.
permissionSettings

object (PermissionSettings)

Không bắt buộc. Chế độ cài đặt quyền đối với không gian cho các không gian hiện có. Dữ liệu đầu vào để cập nhật chế độ cài đặt quyền chính xác cho không gian, trong đó chế độ cài đặt 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.

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 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 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 không gian. Chỉ có đầu ra cho các 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 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à ứng dụng Chat.

SpaceThreadingState

Chỉ định loại trạng thái tạo chuỗi tin nhắn trong không gian Chat.

Enum
SPACE_THREADING_STATE_UNSPECIFIED Đã đặt trước.
THREADED_MESSAGES Không gian được đặt tên hỗ trợ chuỗi tin nhắn. Khi phản hồi một tin nhắn, người dùng có thể trả lời trong chuỗi tin nhắn để phản hồi của họ nằm trong ngữ cảnh của tin nhắn ban đầu.
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 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ả 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. Quy tắc, kỳ vọng và quy tắc ứng xử 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ữ thư 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 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 sẽ chỉ định thời gian lưu giữ thư và chuỗi thư.

MembershipCount

Biểu thị số lượng gói 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ố 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 có tư cách thành viên trong một nhóm đã tham gia.
joinedGroupCount

integer

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 (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 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 Nhóm Google được mời riêng lẻ hoặc được thêm 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 Để đố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.

Việc đọ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 quy trình xác thực ứng dụng.

Bạn cần xác thực người dùng để thiết lập đố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 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 mà 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ể khám phá và truy cập vào không gian.
DISCOVERABLE

Người quản lý không gian đã cấp cho đố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 từng cá nhân 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 Để người dùng cụ thể tìm thấy không gian.

Bạn cần xác thực người dùng để tạo không gian mở.

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. 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, nơi 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 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 @all trong 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 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

Biểu thị 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. Liệu 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 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à hiển thị không gian đó cho người dùng.

create

 Tạo không gian.

delete

 Xoá 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 đã 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 không gian.
Trả về danh sách 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 đã chỉ định vào không gian đó.