Method: spaces.search

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.

Yêu cầu xác thực người dùng bằng đặc quyền quản trị viên. Trong yêu cầu, hãy đặt useAdminAccess thành true.

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/spaces:search

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Thông số
useAdminAccess

boolean

Khi true, phương thức này sẽ chạy bằng các đặ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à cuộc trò chuyện trong không gian.

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

Phương thức này hiện chỉ hỗ trợ quyền quản trị, do đó, chỉ true mới được chấp nhận cho trường này.
pageSize

integer

Số lượng dấu cách 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 thì hệ thống sẽ trả về tối đa 100 dấu cách.

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

string

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

Khi phân trang, tất cả các thông 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 đến các tham số khác có thể dẫn đến kết quả không mong muốn.
query

string

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

Bạn có thể tìm kiếm bằng các tham số sau:

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

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à thông tin bắt buộc và được dùng để cho biết khách hàng nào sẽ tìm nạp không gian. customers/my_customer là giá trị duy nhất được hỗ trợ.

displayName chỉ chấp nhận toán tử HAS (:). Trước tiên, văn bản cần so khớp được mã hoá thành các mã thông báo và mỗi mã thông báo được so khớp tiền tố không phân biệt chữ hoa chữ thường và độc lập dưới dạng một chuỗi con ở bất kỳ vị trí nào 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.

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 và giá trị hợp lệ duy nhất là SPACE.

Trên các trường khác nhau, chỉ 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. Bạn chỉ có thể dùng AND để 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 mẫu sau đây là hợp lệ:

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")
orderBy

string

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

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

  • membershipCount.joined_direct_human_user_count – Cho biết số 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 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 gian tạo không gian.

Các giá trị hợp lệ của toán tử sắp xếp là:

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

  • DESC để giảm dần.

Cú pháp được hỗ trợ là:

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

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Phản hồi bằng danh sách không gian tương ứng với yêu cầu tìm kiếm không gian.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Trường
spaces[]

object (Space)

Một trang chứa các không gian được yêu cầu.
nextPageToken

string

Một mã thông báo có thể dùng để truy xuất trang tiếp theo. Nếu trường này trống thì sẽ không có trang tiếp theo.
totalSize

integer

Tổng số không gian khớp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả là hơn 10.000 khoảng trắng, thì giá trị này là giá trị ước tính.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.