Method: spaces.members.list

Wyświetla listę użytkowników w pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Lista użytkowników korzystających z uwierzytelniania aplikacji zawiera listę użytkowników w pokojach, do których aplikacja Google Chat ma dostęp. Nie uwzględnia przynależności do aplikacji Google Chat, w tym własnych. 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.

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

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 subskrypcji 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łonkostwa. 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 innych wartości do innych parametrów może prowadzić do nieoczekiwanych wyników.

filter

string

Opcjonalnie: Filtr zapytania.

Wspieranie możesz filtrować według roli (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. Podgląd dla programistów: możesz też filtrować tabelę 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 typów członków zostaną odrzucone.

Prawidłowe są na przykład te zapytania:

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"

Nieprawidłowe zapytania są odrzucane przez serwer z błędem 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 wartość filter, subskrypcje z kategorii Google Group, które nie pasują do kryteriów filtra, nie są zwracane.

showInvited

boolean

Opcjonalnie: Gdy true, oprócz innych typów wspierania zwraca także wspieranie powiązane z invited członkami grupy. Jeśli ustawiony jest filtr, subskrypcje z invited, które nie pasują do kryteriów filtra, nie są zwracane.

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 pokoju.

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

Wspieranie aplikacji w pokoju nie jest obsługiwane, gdy korzystasz z dostępu administracyjnego.

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 użytkowników 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 pole jest puste, nie ma kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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.