Method: spaces.members.list

Wyświetla listę użytkowników pokoju. Przykład znajdziesz w artykule Wyświetlanie listy użytkowników i aplikacji Google Chat w pokoju. Wymienianie członkostw z uwierzytelnianiem aplikacji obejmuje członkostwa w pokojach, do których aplikacja Google Chat ma dostęp, ale wyklucza członkostwa w aplikacji Google Chat, w tym własne. Wymienianie członkostw z uwierzytelnianiem użytkownika zawiera członkostwa w przestrzeniach, do których ma dostęp uwierzytelniony użytkownik.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z jednym z tych zakresów autoryzacji:

  • Uwierzytelnianie użytkownika z jednym z tych zakresów autoryzacji:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (tylko pokoje w trybie importowania)
    • Uwierzytelnianie użytkownika przyznaje uprawnienia administratora, gdy konto administratora zostanie uwierzytelnione, useAdminAccess jest true i używany jest jeden z tych zakresów autoryzacji:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

Żą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, dla którego chcesz pobrać listę osób.

Format: spaces/{space}

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba zwracanych wspierań. Usługa może zwrócić mniej niż ta wartość.

Jeśli nie zostanie podana, zwracanych jest maksymalnie 100 subskrypcji.

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 wspierających. Podaj ten parametr, aby pobrać następną stronę.

Podczas stronicowania wszystkie inne podane 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 wartość role na ROLE_MEMBER lub ROLE_MANAGER.

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

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

Jeśli parametr useAdminAccess ma wartość „true”, wymagany jest parametr member.type = "HUMAN" lub member.type != "BOT". Filtry innych typów członków 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"

Nieprawidłowe zapytania są odrzucane przez serwer z błędem INVALID_ARGUMENT.
showGroups

boolean

Opcjonalnie. Gdy true, zwraca też wspieranie powiązane z Google Group, oprócz innych rodzajów wspierania. Jeśli ustawiono filter, nie są zwracane subskrypcje Google Group, które nie spełniają kryteriów filtra.
showInvited

boolean

Opcjonalnie. Gdy true, zwraca też wspieranie powiązane z invited, oprócz innych rodzajów wspierania. Jeśli filtr jest ustawiony, invited subskrypcje, które nie spełniają kryteriów filtra, nie są zwracane.

Obecnie wymaga uwierzytelnienia użytkownika.
useAdminAccess

boolean

Opcjonalnie. Gdy true, metoda jest wykonywana z użyciem uprawnień 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 chat.admin.memberships.readonly lub chat.admin.memberships zakresu OAuth 2.0.

Wyświetlanie członkostwa w aplikacji w pokoju nie jest obsługiwane w przypadku korzystania 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 członkostw 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 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.