Method: spaces.members.list

Wyświetla listę użytkowników w pokoju. Przykładem może być artykuł Członkostwo na liście. Wyświetlanie listy subskrypcji z uwierzytelnianiem aplikacji powoduje wyświetlenie listy subskrypcji w pokojach, do których aplikacja Google Chat ma dostęp. Nie obejmuje jednak subskrypcji aplikacji Google Chat, w tym również własnych. Wyświetlanie listy członków z zastosowaniem uwierzytelniania użytkownika umożliwia wyświetlenie listy członkó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 subskrypcji 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 subskrypcji.

Maksymalna wartość to 1000. Jeśli podasz wartość większą niż 1000, zostanie ona automatycznie zmieniona na wartość 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 podało token strony. Przekazywanie różnych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.
filter

string

Opcjonalnie. Filtr zapytania.

Subskrypcje możesz filtrować według roli członka (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ą na przykład 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 są odrzucane przez serwer z błędem INVALID_ARGUMENT.
showGroups

boolean

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

boolean

Opcjonalnie. Gdy true, oprócz innych typów wspierania, zwracane są również subskrypcje powiązane z invited. Jeśli ustawiony jest filtr, dane o członkostwie w grupie invited, które nie pasują do kryteriów filtra, nie są zwracane.

Obecnie wymaga uwierzytelniania 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 stronie żądanej (lub pierwszej).
nextPageToken

string

Token, który możesz wysłać jako pageToken, aby pobrać następną stronę wyników. Jeśli pole jest puste, 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.