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 người dùng trở lên hoặc tin nhắn 1:1 giữa một người dùng với 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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
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: Thay vào đó, hãy 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ỉ xuất dữ liệu 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: Thay vào đó, hãy dùng spaceThreadingState. Liệu tin nhắn có được tạo chuỗi tin nhắn 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 tại 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 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. Dữ liệu đầu vào khi tạo không gian trong tổ chức trên Google Workspace. Bỏ qua trường này khi tạo dấu cách 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 đều cho phép mọi người dùng Google Chat.

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

Đối với các không gian hiện có, trường này chỉ dành cho kết quả đầu ra.
spaceThreadingState

enum (SpaceThreadingState)

Chỉ có đầu ra. Trạng thái 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à các quy tắc.
spaceHistoryState

enum (HistoryState)

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. Khi đang được nhập, không gian sẽ không hiển thị cho người dù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. Đối với các không gian được tạo trong Chat, thời gian được tạo không gian. Trường này chỉ là 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à 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 dữ liệu đầu ra khi spaceType là GROUP_CHAT hoặc SPACE.
adminInstalled

boolean

Chỉ có đầu ra. Liệu ứng dụng Chat có phải do quản trị viên Google Workspace cài đặt hay không. Quản trị viên có thể cài đặt ứng dụng nhắn tin cho miền, đơn vị tổ chức hoặc một nhóm người dùng của họ.

Quản trị viên chỉ có thể cài đặt ứng dụng nhắn tin để nhắn tin trực tiếp giữa người dùng và ứng dụng. Để hỗ trợ chế độ cài đặt của quản trị viên, ứng dụng của bạn phải có tính năng nhắn tin trực tiếp.
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.

Loại

Không dùng nữa: Thay vào đó, hãy 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 ở dạng phẳng. Xin lưu ý rằng trường hợp 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ỉ xuất dữ liệu 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 trong Chat.
GROUP_CHAT Cuộc trò chuyện nhóm có từ 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 một người với một ứng dụng Chat.

SpaceThreadingState

Chỉ định loại trạng thái chuỗi trong phòng 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 người dùng trả lời một tin nhắn, họ có thể trả lời trong chuỗi tin nhắn, nhờ đó giữ câu trả lời của họ trong ngữ cảnh của tin nhắn gốc.
GROUPED_MESSAGES Không gian được đặt 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 tương ứng đượ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à các 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à 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 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 Tắt nhật ký. 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ữ 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.

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ã nhận dạng đối tượng mục tiêu hợp lệ để giúp đối tượng mục tiêu có thể tìm thấy không gian đó hoặc sử dụng email đạ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 Chuyển một không gian cho đối tượng mục tiêu thành có thể tìm thấy. Huỷ đặt trường này để chuyển không gian thành hạn chế. Chỉ điền dữ liệu khi không gian có thể được tìm thấy. Định dạng: audiences/{audience}, audiences/default có thể được dùng làm bí danh của chế độ cài đặt Chia sẻ mặc định trong Chat.

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 Những thành viên hoặc nhóm được thêm hoặc được mời đều có thể tìm thấy không gian.
DISCOVERABLE Đối tượng mục tiêu đã chọn, cũng như các thành viên/nhóm đã thêm hoặc được mời đều có thể tìm thấy không gian.

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á 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 có thành viên của phương thức gọi.

patch

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

setup

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