Method: spaces.list

列出呼叫端的聊天室成員。群組通訊和即時訊息必須先傳送第一則訊息，系統才會列出相關資訊。如需範例，請參閱「列出聊天室」。

支援下列類型的驗證：

  • 使用授權範圍的應用程式驗證：

    • https://www.googleapis.com/auth/chat.bot

  • 使用下列其中一個授權範圍進行使用者驗證：

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

如要依 Google Workspace 機構列出所有命名空間，請改用 spaces.search() 方法，並使用 Workspace 管理員權限。

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

(非必要) 要傳回的空格數量上限。服務傳回的產品數量可能會少於這個值。

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

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

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

(非必要) 接收自先前 list spaces 呼叫的頁面權杖。提供這個參數即可擷取後續網頁。

進行分頁時，篩選器值應與提供網頁權杖的呼叫相符。傳遞其他值可能會導致非預期的結果。
filter

string

(非必要) 查詢篩選器。

您可以依據聊天室類型 (spaceType) 篩選聊天室。

如要依空間類型篩選，您必須指定有效的列舉值，例如 SPACE 或 GROUP_CHAT (spaceType 不能是 SPACE_TYPE_UNSPECIFIED)。如要查詢多個空間類型，請使用 OR 運算子。

舉例來說，以下查詢有效：

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

伺服器會拒絕無效的查詢，並傳回 INVALID_ARGUMENT 錯誤。

要求主體

要求主體必須為空白。

回應主體

清單聊天室要求的回應。

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

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

object (Space)

要求 (或第一個) 頁面中的聊天室清單。注意：清單要求不會在 Space 物件中傳回 permissionSettings 欄位。
nextPageToken

string

您可以傳送符記做為 pageToken，用於擷取下一頁的結果。如果留空，表示沒有後續網頁。

授權範圍

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

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

詳情請參閱授權指南。