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 aplikacji Google Chat, w tym własne. Wyświetlanie członkostwa z uwierzytelnieniem użytkownika wyświetla członkostwo w przestrzeniach, do których uwierzytelniony użytkownik ma dostęp.

Obsługuje te typy uwierzytelniania:

  • Uwierzytelnianie aplikacji z zakresem autoryzacji:

    • https://www.googleapis.com/auth/chat.bot

  • Uwierzytelnianie użytkownika za pomocą jednego 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 uwierzytelnia, 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, z którego chcesz pobrać listę członków.

Format: spaces/{space}

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 podasz tej wartości, zwrócimy 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. Aby pobrać kolejną stronę, podaj ten parametr.

Podczas podziału na strony wszystkie inne parametry powinny być takie same jak w wywołaniu, 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ć według member.type, używając operatora !=.

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

Gdy element 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, zwraca również wspieranie powiązane z Google Group, oprócz innych typów wspierania. Jeśli ustawisz parametr filter, Google Group członkostwa, które nie pasują do kryteriów filtra, nie zostaną zwrócone.
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, invited nie zwracamy subskrypcji, które nie spełniają kryteriów filtra.

Obecnie wymaga uwierzytelnienia użytkownika.
useAdminAccess

boolean

Opcjonalnie. Jeśli true, metoda jest wykonywana z uprawnieniami administratora Google Workspace.

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 używasz 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 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 dotyczącym autoryzacji.