Method: spaces.search

根據使用者的搜尋內容傳回聊天室清單。需要使用者驗證。使用者必須是 Google Workspace 機構的管理員。在要求中,將 useAdminAccess 設為 true

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
useAdminAccess

boolean

true 時,此方法會使用使用者的 Google Workspace 管理員權限執行。

通話使用者必須是具備管理即時通訊和聊天室對話權限的 Google Workspace 管理員。

需要 chat.admin.spaces.readonlychat.admin.spaces OAuth 2.0 範圍

這個方法目前僅支援管理員存取權,因此這個欄位只接受 true

pageSize

integer

要傳回的聊天室數量上限。服務傳回的產品數量可能會少於這個值。

如未指定,最多會傳回 100 個空格。

值的數量上限是 1000。如果使用的值超過 1000,系統會自動將值變更為 1000。

pageToken

string

從前一個搜尋聊天室呼叫接收的權杖。提供這個參數即可擷取後續網頁。

進行分頁時,提供的所有其他參數應與提供網頁權杖的呼叫相符。將不同的值傳送至其他參數,可能會導致非預期的結果。

query

string

必要欄位。搜尋查詢。

你可以使用下列參數進行搜尋:

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

createTimelastActiveTime 可接受 RFC-3339 格式的時間戳記,且支援的比較運算子為:=<><=>=

customer 是必要項目,用於指出要從哪個客戶擷取聊天室。customers/my_customer 是唯一支援的值。

displayName 只接受 HAS (:) 運算子。要比對的文字會先以代碼化為符記,每個符記均區分大小寫,且獨立為字串 displayName 中任何位置的子字串。舉例來說,Fun Eve 符合 Fun eventThe evening was fun,但不符合 notFun eventeven

externalUserAllowed 接受 truefalse

spaceHistoryState 只接受 space 資源 historyState 欄位中的值。

必須提供 spaceType,且唯一有效值為 SPACE

不同欄位僅支援 AND 運算子。有效的範例為 spaceType = "SPACE" AND displayName:"Hello",無效的範例為 spaceType = "SPACE" OR displayName:"Hello"

在相同欄位中,spaceType 不支援 ANDOR 運算子。displayName、「spaceHistoryState」和「externalUserAllowed」僅支援 OR 運算子。lastActiveTimecreateTime 同時支援 ANDOR 運算子。AND 只能用來表示間隔,例如 lastActiveTime < "2022-01-01T00:00:00+00:00" AND lastActiveTime > "2023-01-01T00:00:00+00:00"

以下查詢範例有效:

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

選用設定。聊天室清單的排序方式。

支援的排序屬性如下:

  • membershipCount.joined_direct_human_user_count — 表示直接加入聊天室的真人使用者人數。
  • lastActiveTime:表示最後一個符合資格的項目新增至這個聊天室主題的時間。
  • createTime:表示聊天室建立時間,

有效的排序作業值如下:

  • ASC 代表遞增。預設值。

  • DESC 代表遞減。

支援的語法如下:

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

要求主體

要求主體必須為空白。

回應主體

傳回與搜尋聊天室要求相對應的聊天室清單。

如果成功,回應主體會含有以下結構的資料:

JSON 表示法
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
欄位
spaces[]

object (Space)

要求的聊天室頁面。

nextPageToken

string

可用來擷取下一頁的權杖。如果這個欄位留空,表示沒有後續網頁。

totalSize

integer

在所有網頁中,符合查詢的聊天室總數。如果結果超過 10,000 個空格,此值即為估計值。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱授權指南