useAdminAccess
設為 true
。
HTTP 要求
GET https://chat.googleapis.com/v1/spaces:search
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
useAdminAccess |
當 通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。 需要 此方法目前僅支援管理員存取權,因此這個欄位只接受 |
pageSize |
要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。 如未指定,最多會傳回 100 個空格。 最大值是 1000。如果您使用的值超過 1000,系統會自動變更為 1000。 |
pageToken |
從先前的搜尋聊天室呼叫獲得的權杖。提供這個參數即可擷取後續網頁。 進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。如果將不同的值傳遞給其他參數,可能會導致非預期的結果。 |
query |
必要欄位。搜尋查詢。 您可以使用下列參數進行搜尋: -
不同欄位僅支援 在同一個欄位中, 以下是有效的查詢範例:
|
orderBy |
選用設定。聊天室清單的排序方式。 支援的排序依據屬性如下:
有效的排序作業值如下:
支援的語法如下:
|
要求主體
要求主體必須為空白。
回應主體
回應包含與搜尋聊天室要求對應的空格清單。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"spaces": [
{
object ( |
欄位 | |
---|---|
spaces[] |
要求的聊天室頁面。 |
nextPageToken |
可用於擷取下一頁的權杖。如果這個欄位留空,表示沒有後續網頁。 |
totalSize |
在所有網頁中,符合查詢的空格總數。如果結果超過 10,000 個空格,此值即是預估值。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
詳情請參閱授權指南。