Method: spaces.members.list

Wyświetla listę użytkowników pokoju. Przykład: Lista użytkowników i aplikacji Google Chat w pokoju. Wyświetlanie członkostwa z autoryzacją aplikacji wyświetla członkostwo w pokojach, do których ma dostęp aplikacja Google Chat, ale wyklucza członkostwo w Google Chat, w tym własne. Lista użytkowników z ustawieniem Uwierzytelnianie użytkowników zawiera listę użytkowników w pokojach, do których ma dostęp uwierzytelniony użytkownik.

Obsługuje te typy uwierzytelniania:

Żą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

Wymagane. Nazwa zasobu pokoju, do którego ma zostać pobrana lista użytkowników.

Format: spacje/{spacja}

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie: Maksymalna liczba wspierających do zwrócenia. Usługa może zwrócić mniej niż ta wartość.

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

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

string

Opcjonalnie: Filtr zapytania.

Możesz filtrować członkostwa według roli (role) i typu (member.type) członka.

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

Aby filtrować według typu, ustaw wartość member.type na HUMAN lub BOT. Możesz też filtrować dane pod kątem member.type, używając operatora !=.

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

Gdy zasada useAdminAccess ma wartość Prawda, wymagana jest właściwość member.type = "HUMAN" lub member.type != "BOT". Inne filtry typu członka zostaną odrzucone.

Na przykład te zapytania są prawidłowe:

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

member.type != "BOT"

Te zapytania są nieprawidłowe:

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

Serwer odrzuca nieprawidłowe zapytania, zwracając błąd INVALID_ARGUMENT.
showGroups

boolean

Opcjonalnie: Gdy true, oprócz innych typów wspierania zwraca także informacje o wspieraniu powiązane z elementem Google Group. Jeśli ustawiona jest opcja filter, Google Group członkostwa, które nie pasują do kryteriów filtra, nie są zwracane.
showInvited

boolean

Opcjonalnie: Jeśli true, zwraca również wspierających powiązanych z invited, oprócz innych typów wspierających. Jeśli ustawiony jest filtr, invitednie zwracamy subskrypcji, które nie spełniają kryteriów filtra.

Obecnie wymaga uwierzytelniania użytkownika.
useAdminAccess

boolean

Jeśli zasada jest true, metoda jest uruchamiana z uprawnieniami administratora Google Workspace użytkownika.

Użytkownik dzwoniący musi być administratorem Google Workspace z uprawnieniami do zarządzania czatem i rozmowami w pokojach.

Wymaga zakresu chat.admin.memberships.readonly lub chat.admin.memberships OAuth 2.0.

Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administratora.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę osób w pokoju

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 członkostw na stronie, której dotyczy żądanie (lub pierwszej stronie).
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.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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 na temat autoryzacji.