Method: spaces.list

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

列出呼叫者所屬的聊天室。需要驗證。完整支援服務帳戶驗證。

支援使用者驗證，這是 Google Workspace 開發人員預覽計劃的一部分，可讓使用者搶先體驗特定功能。使用者驗證需要 chat.spaces 或 chat.spaces.readonly 授權範圍。

列出呼叫者或已驗證使用者可見的聊天室。系統只會傳送第一則訊息，而且不會顯示群組通訊和即時訊息。

HTTP 要求

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

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

查詢參數

參數
pageSize

integer

選填欄位，要傳回的空格數上限。服務傳回的值可能會少於這個值。

如果未指定，則最多傳回 100 個空格。

最大值是 1000； 1000 以上的值被為 1000。

負值會傳回 INVALID_ARGUMENT 錯誤。
pageToken

string

選填欄位，從先前的清單空間呼叫收到的網頁憑證。請提供這個 ID 以擷取後續網頁。

進行分頁時，篩選器值必須與提供網頁憑證的呼叫相符。傳遞不同的值可能會導致非預期的結果。
filter

string

選填欄位，查詢篩選器。

需要使用者驗證。

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

如要按照空格類型篩選，您必須指定有效的 enum 值，例如 SPACE 或 GROUP_CHAT (spaceType 不得為 SPACE_TYPE_UNSPECIFIED)。如要查詢多種空格類型，請使用 OR 運算子。

例如，以下查詢是有效的：

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

伺服器已拒絕 INVALID_ARGUMENT 錯誤，導致查詢無效。

使用服務帳戶驗證時，系統會忽略這個欄位，而且查詢一律會傳回所有空格。不過，Chat API 仍會透過服務帳戶驗證查詢語法，因此無效查詢仍然會遭到拒絕。

要求主體

要求主體必須為空白。

回應主體

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

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

object (Space)

要求 (或第一個) 頁面中的聊天室清單。
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

詳情請參閱授權指南。