Method: spaces.list

Wyświetla listę pokoi, których członkiem jest rozmówca. Czaty grupowe i czaty są widoczne dopiero po wysłaniu pierwszej wiadomości. Przykład: Wyświetlanie listy pokoi.

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

Zawiera listę pokoi widocznych dla rozmówcy lub uwierzytelnionego użytkownika. Czaty grupowe i czaty są widoczne dopiero po wysłaniu pierwszej wiadomości.

Żą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ć mniejszą wartość od tej wartości.

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 odebrany z poprzedniego wywołania pokoi list. Podaj ten parametr, aby pobrać kolejną stronę.

W przypadku podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Przekazywanie innej wartości może spowodować nieoczekiwane wyniki.

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 wyszukać wiele typów pokoi, użyj operatora OR.

Prawidłowe są np. te zapytania:

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

Nieprawidłowe zapytania zostały odrzucone przez serwer z błędem INVALID_ARGUMENT.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Możesz wysłać token jako pageToken, aby pobrać następną stronę wyników. Jeśli ta wartość jest pusta, 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 po autoryzacji.