Method: spaces.findGroupChats

傳回所有具有 spaceType == GROUP_CHAT 的聊天室，這些聊天室的人類成員必須包含呼叫使用者和 FindGroupChatsRequest.memberships 中指定的使用者。

如果呼叫使用者封鎖或遭到部分使用者封鎖，且系統找不到包含所有指定使用者的聊天室，這個方法會傳回不含遭封鎖或封鎖使用者的聊天室。

指定的使用者組合只能包含人類 (非應用程式) 成員。如果要求包含非真人使用者，系統不會傳回任何聊天室。

需要使用者驗證，並使用下列其中一個授權範圍：

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

HTTP 要求

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

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

查詢參數

參數
user[]

string

與通話使用者進行群組即時通訊的所有人類使用者資源名稱。要求中不得包含即時通訊應用程式。

格式：users/{user}，其中 {user} 是 People API 中人員的 id，或是 Directory API 中使用者的 id。舉例來說，如要找出與通話使用者和其他兩位使用者 (People API 設定檔 ID 為 123456789 和 987654321) 的所有群組對話，可以使用 users/123456789 和 users/987654321。您也可以將該電子郵件地址做為 {user} 的別名。舉例來說，users/example@gmail.com，其中 example@gmail.com 是 Google Chat 使用者的電子郵件地址。

如果通話使用者是 Google Workspace 使用者，所有受邀使用者都必須與通話使用者屬於同一個 Google Workspace 機構。
pageSize

integer

(選用步驟) 要傳回的空間數量上限。服務傳回的產品數量可能會少於這個值。

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

值的上限為 1000。如果使用超過 1000 的值，系統會自動變更為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

(選用步驟) 屬於接收自前一個呼叫的網頁權杖，用於尋找群組通訊。提供此參數即可擷取後續網頁。

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

enum (SpaceView)

要求的空間檢視類型。如未設定，則預設為 SPACE_VIEW_RESOURCE_NAME_ONLY。指定 SPACE_VIEW_EXPANDED 的要求必須包含允許讀取聊天室資料的範圍，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。

要求主體

要求主體必須為空白。

回應主體

回應內容包含群組對話聊天室，且聊天室成員只有通話使用者和要求的使用者。

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

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

object (Space)

所要求 (或第一) 頁面中的聊天室清單。
nextPageToken

string

可做為 pageToken 傳送的權杖，用於擷取後續網頁的結果。如果留空，表示沒有後續網頁。

授權範圍

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

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

詳情請參閱授權指南。

SpaceView

這個檢視畫面會指定要在 Space 資源上填入哪些欄位。為確保與日後版本相容，建議您的程式碼納入其他值。

列舉
SPACE_VIEW_UNSPECIFIED 預設 / 未設定值。
SPACE_VIEW_RESOURCE_NAME_ONLY 只會填入聊天室資源名稱。
SPACE_VIEW_EXPANDED 填入 Space 資源欄位。注意：系統不會填入 permissionSettings 欄位。指定 SPACE_VIEW_EXPANDED 的要求必須包含允許讀取聊天室資料的範圍，例如 https://www.googleapis.com/auth/chat.spaces 或 https://www.googleapis.com/auth/chat.spaces.readonly。