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à một ứ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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
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} đại diện cho 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 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 của một không gian. Chỉ có đầu ra cho các trường hợp 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: Hãy sử dụng spaceThreadingState. Liệu tin nhắn có được phân thành 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 có 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. 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:

  • Người dùng đã xác thực sử dụng tài khoản người dùng thông thường (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 bất kỳ người dùng Google Chat nào tham gia.

Đối với 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 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 cả 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 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 không gian đang được 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 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, 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 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 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

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

sessionState

enum (SpaceSessionState)

Chỉ có đầu ra. Trạng thái phiên của không gian.

sessionEnableTime

string (Timestamp format)

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

string (Timestamp format)

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 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 bằng phương thức xác thực ứng dụng và SpaceType là SPACE, nếu không thì không nên đặt.

Ở định dạng customers/{customer}, trong đó customer là id từ tài nguyên khách hàng của SDK dành cho quản trị viên. Ứ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.

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

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

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

permissionSettings

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

  • Cuộc trò chuyện liên tục của cuộc họp mà trong đó tính năng tạo chuỗi tin nhắn bị tắt có chủ đích.
  • Cuộc trò chuyện nhóm cũ được tạo trước năm 2022.

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

string

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

integer

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

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,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
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 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 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 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 chat.bot với phương thức xác thực ứng dụng.

Để đặt đối tượng mục tiêu, bạn cần xác thực người dùng.

accessPermissionSettings

object (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 accessSettings.audience trong yêu cầu của bạ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 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 (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
Trường
discoverSpaceSetting

object (AccessPermissionSetting)

Không bắt buộc. Chế độ cài đặt bộ quyền để khám phá không gian.

joinSpaceSetting

object (AccessPermissionSetting)

Không bắt buộc. Chế độ cài đặt bộ quyền truy cập để tham gia không gian.

viewSpaceMembershipSetting

object (AccessPermissionSetting)

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 PermissionSettings.view_space_membership trong mặt nạ cập nhật và nội dung yêu cầu khi cập nhật những người có thể xem danh sách thành viên của không gian. Khi cấp quyền xem cho một đối tượng mục tiêu, bạn cũng phải cấp PermissionSettings.view_space_membership cho tất cả thành viên trong cùng một yêu cầu. Để xoá một đối tượng mục tiêu hiện có (ví dụ: để chỉ cho phép người quản lý không gian hoặc người quản lý phụ có quyền xem), hãy chỉ định một AccessPermissionSetting trống (không có principals).

AccessPermissionSetting

Chế độ cài đặt quyền truy cập.

Biểu diễn dưới dạng JSON
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
Trường
principals[]

object (Principal)

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 (Audience)
  }
}
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

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

string

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: 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.

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 (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  },
  "viewSpaceMembership": {
    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 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ý không gian.

useAtMentionAll

object (PermissionSetting)

Không bắt buộc. Chế độ cài đặt để sử dụng @all 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 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.

viewSpaceMembership

object (PermissionSetting)

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 AccessPermissionSettings.view_space_membership_setting trong mặt nạ cập nhật và nội dung yêu cầu khi cập nhật những người có thể xem danh sách thành viên của không gian. Khi hạn chế quyền xem đối với một số vai trò cụ thể (ví dụ: chỉ người quản lý không gian hoặc người quản lý trợ lý), hãy chỉ định quyền của vai trò mong muốn tại đây và cung cấp một AccessPermissionSettings.view_space_membership_setting trống trong cùng một yêu cầu. Nếu bạn thiết lập đối tượng mục tiêu trong AccessPermissionSettings.view_space_membership_setting, thì bạn phải cấp quyền này cho tất cả thành viên.

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

boolean

Không bắt buộc. Chủ sở hữu không gian (ROLE_MANAGER) có quyền này hay không.

membersAllowed

boolean

Không bắt buộc. Liệu thành viên cơ bản trong không gian (ROLE_MEMBER) có quyền này hay không.

assistantManagersAllowed

boolean

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

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

completeImport

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

create

Tạo không gian.

delete

Xoá một không gian có tên.

findDirectMessage

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

findGroupChats

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.

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 trên Google Workspace.

setup

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