Method: spaces.list

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

Obsługuje te typy uwierzytelniania:

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 zostanie podana żadna wartość, zwróci się 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. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wartość filtra powinna odpowiadać wywołaniu, które dostarczyło token strony. Podanie 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 pomieszczenia, musisz podać prawidłową wartość z użyciem enum, np. SPACE lub GROUP_CHAT (wartość spaceType nie może być równa SPACE_TYPE_UNSPECIFIED). Aby zapytać o kilka typów pomieszczeń, 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 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 stronie, której dotyczy żądanie (lub na pierwszej stronie). Uwaga: pole permissionSettings nie jest zwracane w przypadku żądań listy w obiekcie pokoju.
nextPageToken

string

Aby pobrać kolejną 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 dotyczącym autoryzacji.