Method: spaces.search

boolean

Khi true, phương thức sẽ chạy bằng đặc quyền quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian.

Yêu cầu phạm vi OAuth 2.0 chat.admin.spaces.readonly hoặc chat.admin.spaces.

Bạn có thể đặt useAdminAccess thành false trong Bản dùng trước cho nhà phát triển.

integer

Số lượng không gian tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không chỉ định, hệ thống sẽ trả về tối đa 100 không gian.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị đó sẽ tự động thay đổi thành 1000.

string

Mã thông báo nhận được từ lệnh gọi tìm kiếm không gian trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc truyền các giá trị khác nhau cho các tham số khác có thể dẫn đến kết quả không mong muốn.

string

Bắt buộc. Cụm từ tìm kiếm.

Bạn có thể tìm kiếm bằng cách sử dụng các tham số sau khi useAdminAccess được đặt thành true:

• createTime
• customer
• displayName
• externalUserAllowed
• lastActiveTime
• spaceHistoryState
• spaceType

Khi useAdminAccess được đặt thành false:

• displayName
• externalUserAllowed

createTime và lastActiveTime chấp nhận dấu thời gian ở định dạng RFC-3339 và các toán tử so sánh được hỗ trợ là: =, <, >, <=, >=.

customer là bắt buộc khi useAdminAccess được đặt thành true và được dùng để cho biết khách hàng cần tìm nạp không gian. customers/my_customer là giá trị được hỗ trợ duy nhất.

displayName chỉ chấp nhận toán tử HAS (:). Văn bản cần so khớp trước tiên được mã hoá thành các mã thông báo và mỗi mã thông báo được so khớp theo tiền tố một cách độc lập và không phân biệt chữ hoa chữ thường dưới dạng chuỗi con ở bất kỳ đâu trong displayName của không gian. Ví dụ: Fun Eve khớp với Fun event hoặc The evening was fun, nhưng không khớp với notFun event hoặc even. Khi useAdminAccess được đặt thành false, bạn phải có displayName để truy xuất kết quả có ý nghĩa. Nếu không, hành vi mặc định là trả về phản hồi trống.

externalUserAllowed chấp nhận true hoặc false.

spaceHistoryState chỉ chấp nhận các giá trị từ trường historyState của tài nguyên space.

spaceType là bắt buộc khi useAdminAccess được đặt thành true và giá trị hợp lệ duy nhất là SPACE.

Trên các trường khác nhau, chỉ các toán tử AND được hỗ trợ. Ví dụ hợp lệ là spaceType = "SPACE" AND displayName:"Hello" và ví dụ không hợp lệ là spaceType = "SPACE" OR displayName:"Hello".

Trong cùng một trường, spaceType không hỗ trợ toán tử AND hoặc OR. displayName, 'spaceHistoryState' và 'externalUserAllowed' chỉ hỗ trợ toán tử OR. lastActiveTime và createTime hỗ trợ cả toán tử AND và OR. AND chỉ có thể dùng để biểu thị một khoảng thời gian, chẳng hạn như lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00".

Các truy vấn ví dụ sau đây là hợp lệ khi useAdminAccess được đặt thành true:

customer = "customers/my_customer" AND spaceType = "SPACE"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
displayName:"Hello World"

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(lastActiveTime < "2020-01-01T00:00:00+00:00" OR lastActiveTime >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(displayName:"Hello World" OR displayName:"Fun event") AND
(lastActiveTime > "2020-01-01T00:00:00+00:00" AND lastActiveTime <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND spaceType = "SPACE" AND
(createTime > "2019-01-01T00:00:00+00:00" AND createTime <
"2020-01-01T00:00:00+00:00") AND (externalUserAllowed = "true") AND
(spaceHistoryState = "HISTORY_ON" OR spaceHistoryState = "HISTORY_OFF")

Các truy vấn ví dụ sau đây là hợp lệ khi useAdminAccess được đặt thành false:

displayName:"Hello World"

(displayName:"Hello" OR displayName:"Fun")

(externalUserAllowed = "true") // Returns an empty response.

(externalUserAllowed = "true" AND displayName:"Hello")

string

Không bắt buộc. Cách sắp xếp danh sách không gian.

Các thuộc tính được hỗ trợ để sắp xếp là:

• membershipCount.joined_direct_human_user_count – Cho biết số lượng người dùng đã trực tiếp tham gia một không gian.
• lastActiveTime – Cho biết thời điểm mục đủ điều kiện gần đây nhất được thêm vào bất kỳ chủ đề nào của không gian này.
• createTime – Cho biết thời điểm tạo không gian.

Khi useAdminAccess là false, chỉ createTime và relevance được hỗ trợ để sắp xếp. Chỉ DESC được hỗ trợ cho các trường này trong các lượt tìm kiếm không phải của quản trị viên.

Các giá trị thao tác sắp xếp hợp lệ là:

• ASC để tăng dần. Giá trị mặc định.

• DESC để giảm dần.

Cú pháp được hỗ trợ là khi useAdminAccess được đặt thành true:

• membershipCount.joined_direct_human_user_count DESC
• membershipCount.joined_direct_human_user_count ASC
• lastActiveTime DESC
• lastActiveTime ASC
• createTime DESC
• createTime ASC

Khi useAdminAccess được đặt thành false:

• createTime DESC
• relevance DESC

object (Space)

Chỉ có đầu ra. Không gian được so khớp.