Method: spaces.list

Lista pokoi, których użytkownik jest członkiem. Czaty grupowe i czaty bezpośrednie nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykładem jest lista pokoi.

Obsługuje te typy uwierzytelniania:

Aby wyświetlić listę wszystkich nazwanych pokoi w organizacji Google Workspace, użyj metody spaces.search(), korzystając z uprawnień administratora Workspace.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba miejsc do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie zostanie podany, zwracane jest maksymalnie 100 miejsc.

Maksymalna wartość to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie ona automatycznie zmieniona na 1000.

Wartości ujemne zwracają błąd INVALID_ARGUMENT.
pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy pokoi. Aby pobrać kolejną stronę, podaj ten parametr.

Podczas podziału na strony wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Podanie innej wartości może spowodować nieoczekiwane wyniki.
filter

string

Opcjonalnie. Filtr zapytania.

Możesz filtrować pokoje według typu pokoju (spaceType).

Aby filtrować według typu pokoju, musisz podać prawidłową wartość z użyciem listy wyliczeń, np. SPACE lub GROUP_CHAT (wartość spaceType nie może być równa SPACE_TYPE_UNSPECIFIED). Aby przesłać zapytanie dotyczące wielu typów pokoi, użyj operatora OR.

Na przykład te zapytania są prawidłowe:

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

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie listy pokoi.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Pola
spaces[]

object (Space)

Lista pokoi na żądanej (lub pierwszej) stronie. Uwaga: w przypadku żądań listy pole permissionSettings nie jest zwracane w obiekcie pokoju.
nextPageToken

string

Aby pobrać następną stronę wyników, możesz wysłać token jako pageToken. Jeśli jest puste, nie ma kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.