Method: spaces.search

Trả về danh sách các 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. Trong yêu cầu, hãy đặt useAdminAccess thành true. Để biết ví dụ, hãy xem bài viết Tìm kiếm và quản lý không gian.

Yêu cầu xác thực người dùng có đặc quyền quản trị viên và một trong các phạm vi uỷ quyền sau đây:

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

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

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 truy cập của quản trị viên, do đó, chỉ true được chấp nhận cho trường này.

pageSize

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, thì 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 1.000, giá trị đó sẽ tự động thay đổi thành 1.000.

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

query

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:

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

createTimelastActiveTime 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 và được dùng để cho biết khách hàng nào cần 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 (:). Văn bản cần 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 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 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à thuộc tính bắt buộc và giá trị hợp lệ duy nhất là SPACE.

Trên nhiều trường, 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ợ các toán tử OR. lastActiveTimecreateTime hỗ trợ cả toán tử ANDOR. 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.

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

  • membershipCount.joined_direct_human_user_count – Cho biết số người dùng là người dùng thực đã tham gia trực tiếp vào một không gian.
  • lastActiveTime – Biểu thị 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 – Biểu thị thời gian tạo không gian.

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

  • ASC cho thứ tự tăng dần. Giá trị mặc định.

  • DESC cho thứ tự 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 các 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 gồm 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, tức là không có trang tiếp theo.

totalSize

integer

Tổng số khoảng trống khớp với cụm từ tìm kiếm trên tất cả các trang. Nếu kết quả có 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.