Method: spaces.list

Zawiera listę pokoi, do których należy rozmówca. Czaty grupowe i czaty nie będą widoczne, dopóki nie zostanie wysłana pierwsza wiadomość. Przykładem może być Lista pokoi.

Wymaga uwierzytelniania. Pełna obsługa uwierzytelniania konta usługi i uwierzytelniania użytkowników.

Zawiera listę pokoi widocznych dla rozmówcy lub uwierzytelnionego użytkownika. Czaty grupowe i czaty nie będą widoczne, dopóki nie zostanie wysłana pierwsza wiadomość.

Żą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ść niż ta wartość.

Jeśli wartość nie zostanie podana, zostanie zwróconych maksymalnie 100 spacji.

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

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

string

Opcjonalnie. Token strony, otrzymany z poprzedniego wywołania listy pokoi. Podaj ten parametr w celu pobrania następnej strony.

W podziale 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 zapytań.

Wymaga uwierzytelniania użytkownika.

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

Aby filtrować według typu pokoju, musisz określić prawidłową wartość wyliczeniową, np. SPACE lub GROUP_CHAT (spaceType nie może mieć wartości SPACE_TYPE_UNSPECIFIED). Aby wysłać zapytanie do wielu 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.

W przypadku uwierzytelniania konta usługi to pole jest ignorowane, a zapytanie zawsze zwraca wszystkie spacje. Interfejs Chat API nadal jednak sprawdza składnię zapytań za pomocą kont usługi, więc nieprawidłowe zapytania są odrzucane.

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

Aby pobrać następną stronę wyników, możesz wysłać token jako pageToken. Brak wartości oznacza, że 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.