Method: spaces.list

Wyświetla listę pokoi, do których należy rozmówca. Czaty grupowe i czaty nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość. Przykład znajdziesz w sekcji Tworzenie listy pokoi.

Wymaga uwierzytelniania. Obsługuje uwierzytelnianie aplikacji i uwierzytelnianie użytkowników.

Wyświetla listę pokoi widocznych dla rozmówcy lub uwierzytelnionego użytkownika. Czaty grupowe i czaty nie są wyświetlane, dopóki nie zostanie wysłana pierwsza wiadomość.

Aby wyświetlić wszystkie nazwane pokoje według organizacji Google Workspace, użyj metody spaces.search() z uprawnieniami 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 spacji do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie określono inaczej, zwracanych jest maksymalnie 100 spacji.

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. Podaj ten parametr, aby pobrać kolejną stronę.

Przy dzieleniu na strony wartość filtra powinna być zgodna z wywołaniem, które dostarczyło token strony. Przekazywanie innej wartości może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie: Filtr zapytania.

Pokoje możesz filtrować według typu pokoju (spaceType).

Aby filtrować według typu pokoju, musisz podać prawidłową wartość wyliczeniową, np. SPACE lub GROUP_CHAT (spaceType nie może mieć wartości SPACE_TYPE_UNSPECIFIED). Aby wysłać zapytanie dotyczące wielu typów pokojów, użyj operatora OR.

Prawidłowe są na przykład te zapytania:

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

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie dotyczące pokoi z listą.

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.
nextPageToken

string

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.