Masz 5 minut? Pomóż nam ulepszać dokumentację Google Chat dla deweloperów, wypełniając krótką ankietę.

Method: spaces.members.list

Wyświetla listę użytkowników w pokoju. Przykładem może być lista wspierania. Subskrypcja z uwierzytelnianiem aplikacji zawiera listę użytkowników w pokojach, do których aplikacja ma dostęp, ale nie obejmuje tych użytkowników, w tym własnych. Subskrypcja z uwierzytelnianiem użytkownika zawiera listę użytkowników w pokojach, do których uwierzytelniony użytkownik ma dostęp.

Wymaga uwierzytelniania. Pełna obsługa uwierzytelniania konta usługi i uwierzytelniania użytkowników. Uwierzytelnianie użytkownika.

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

Wymagany. Nazwa zasobu pokoju, którego listę chcesz pobrać.

Format: spacje/{spacja}

Parametry zapytania

Parametry
pageSize

integer

Opcjonalnie. Maksymalna liczba subskrypcji, które zostaną zwrócone. Usługa może zwrócić mniejszą wartość niż ta wartość.

Jeśli wartość nie jest określona, zwracanych jest maksymalnie 100 wspierań.

Wartość maksymalna to 1000. Jeśli użyjesz wartości większej niż 1000, zostanie automatycznie zmieniona na 1000.

Wartości ujemne oznaczają błąd INVALID_ARGUMENT.

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniego wywołania listy. Podaj ten parametr w celu pobrania następnej strony.

W podziale na strony wszystkie pozostałe podane parametry powinny być zgodne z wywołaniem dostarczonym przez token strony. Przekazywanie różnych wartości innym parametrom może prowadzić do nieoczekiwanych wyników.

filter

string

Opcjonalnie. Filtr zapytań.

Możesz filtrować członkostwo 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ą np. 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 zostały odrzucone przez serwer z błędem INVALID_ARGUMENT.

showGroups

boolean

Opcjonalnie. Gdy true zwraca też wspieranie powiązane z Google Group, oraz innych typów wspierania. Jeśli zasada filter jest ustawiona, członkostwo Google Group, które nie spełnia kryteriów filtrowania, nie jest zwracane.

showInvited

boolean

Opcjonalnie. Gdy true zwraca też wspieranie powiązane z invited subskrypcjami oraz inne typy wspierania. Jeśli ustawisz filtr, członkostwo invited, które nie spełnia kryteriów filtrowania, nie jest zwracane.

Obecnie wymaga uwierzytelniania użytkowników.

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 subskrypcji na żądanej (lub pierwszej) stronie.

nextPageToken

string

Token, który możesz wysłać jako pageToken, aby pobrać następną stronę wyników. Brak wartości oznacza, że nie ma kolejnych stron.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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