Method: spaces.members.list

Wyświetla listę członkostwa w pokoju. Aby to zrobić, zapoznaj się z artykułem Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Wyświetlanie informacji o członkostwie w pokojach z uwierzytelnianiem aplikacji powoduje wyświetlenie listy osób znajdujących się w pokojach, do których aplikacja Google Chat ma dostęp, ale z wyłączeniem funkcji wspierania w aplikacji Google Chat, w tym do pokoi własnych. Uwierzytelnianie użytkowników pozwala wyświetlić listę użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik.

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

Żądanie HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
parent

string

To pole jest wymagane. Nazwa zasobu pokoju, dla którego ma zostać pobrana lista użytkowników.

Format: spacje/{spacja}

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba członkostw 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 członków.

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

W przypadku podziału na strony wszystkie pozostałe parametry powinny być zgodne z wywołaniem, które dostarczyło token strony. Przekazywanie różnych wartości do pozostałych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie. Filtr zapytania.

Członkostwa możesz filtrować według roli użytkownika (role) i typu (member.type).

Aby filtrować według roli, ustaw role na ROLE_MEMBER lub ROLE_MANAGER.

Aby filtrować według typu, ustaw member.type na HUMAN lub BOT.

Aby filtrować według roli i typu, użyj operatora AND. Aby filtrować według roli lub typu, użyj operatora OR.

Prawidłowe są np. te zapytania:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

Te zapytania są nieprawidłowe:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

Opcjonalnie. Gdy true zwraca też subskrypcje powiązane z elementem Google Group, a także z innymi typami wspierania. Jeśli ustawiona jest wartość filter, subskrypcje (Google Group), które nie pasują do kryteriów filtra, nie są zwracane.
showInvited

boolean

Opcjonalnie. Gdy true zwraca również subskrypcje powiązane z użytkownikami invited, niezależnie od innych typów wspierania. Jeśli jest ustawiony filtr, subskrypcje (invited), które nie pasują do kryteriów filtra, nie są zwracane.

Obecnie wymagane jest uwierzytelnianie użytkownika.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

Zapis JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Pola
memberships[]

object (Membership)

Lista nieuporządkowana. Lista subskrypcji na żądanej (lub pierwszej) stronie.
nextPageToken

string

Token, który możesz wysłać 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.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.