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 |
Khi 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 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ỉ |
pageSize |
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 |
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 |
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:
Trên nhiều trường, chỉ toán tử Trong cùng một trường, Các truy vấn mẫu sau đây là hợp lệ:
|
orderBy |
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à:
Các giá trị hợp lệ cho thao tác sắp xếp là:
Cú pháp được hỗ trợ là:
|
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 ( |
Trường | |
---|---|
spaces[] |
Một trang gồm các không gian được yêu cầu. |
nextPageToken |
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 |
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.