Method: spaces.search

boolean

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

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

需要 chat.admin.spaces.readonly 或 chat.admin.spaces OAuth 2.0 範圍。

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

integer

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

如未指定，最多會傳回 100 個空間。

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

string

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

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

string

必要欄位。搜尋查詢。

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

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

createTime 和 lastActiveTime 可接受 RFC-3339 格式的時間戳記，且支援的比較運算子為：=、<、>、<=、>=。

customer 為必要參數，用於指出要從哪位客戶擷取聊天室。customers/my_customer 是唯一支援的值。

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

externalUserAllowed 接受 true 或 false。

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

spaceType 為必填欄位，唯一有效的值為 SPACE。

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

在相同欄位中，spaceType 不支援 AND 或 OR 運算子。displayName、"spaceHistoryState" 和 "externalUserAllowed" 僅支援 OR 運算子。lastActiveTime 和 createTime 都支援 AND 和 OR 運算子。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")

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