Method: spaces.members.list

Listet Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Nutzer und Google Chat-Apps in einem Gruppenbereich auflisten. Wenn Sie Mitgliedschaften über die App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die die Chat-App Zugriff hat. Mitgliedschaften in der Chat-App, einschließlich ihrer eigenen, werden jedoch ausgeschlossen. Wenn Sie Mitgliedschaften über die Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die der authentifizierte Nutzer Zugriff hat.

Erfordert eine Authentifizierung. Unterstützt die App-Authentifizierung und die Nutzerauthentifizierung.

HTTP-Anfrage

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll.

Format: Leerzeichen/{Leerzeichen}

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl von Mitgliedschaften, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn keine Angabe gemacht wird, werden maximal 100 Mitgliedschaften zurückgegeben.

Der Höchstwert beträgt 1.000. Wenn Sie einen höheren Wert als 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
pageToken

string

Optional. Seitentoken, das von einem vorherigen Aufruf zur Auflistung von Mitgliedschaften erhalten wurde. Geben Sie diesen Parameter an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe unterschiedlicher Werte an die anderen Parameter kann zu unerwarteten Ergebnissen führen.
filter

string

Optional. Einen Abfragefilter.

Du kannst Mitgliedschaften nach der Rolle eines Mitglieds (role) und dem Typ (member.type) filtern.

Wenn Sie nach Rolle filtern möchten, setzen Sie role auf ROLE_MEMBER oder ROLE_MANAGER.

Wenn Sie nach Typ filtern möchten, setzen Sie member.type auf HUMAN oder BOT. Entwicklervorschau: Mit dem Operator != kannst du auch nach member.type filtern.

Verwenden Sie den Operator AND, um sowohl nach Rolle als auch nach Typ zu filtern. Verwenden Sie den Operator OR, um nach Rolle oder Typ zu filtern.

member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn useAdminAccess auf „true“ gesetzt ist. Andere Mitgliedstypfilter werden abgelehnt.

Die folgenden Abfragen sind beispielsweise gültig:

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

member.type != "BOT"

Die folgenden Abfragen sind ungültig:

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

Ungültige Anfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
showGroups

boolean

Optional. Bei true werden neben anderen Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit einer Google Group verknüpft sind. Wenn eine filter festgelegt ist, werden Google Group-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.
showInvited

boolean

Optional. Bei true werden neben anderen Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit invited Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden invited-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

Erfordert derzeit eine Nutzerauthentifizierung.
useAdminAccess

boolean

Wenn true, wird die Methode mit den Google Workspace-Administratorberechtigungen des Nutzers ausgeführt.

Der anrufende Nutzer muss ein Google Workspace-Administrator mit der Berechtigung „Unterhaltungen in Chats und Gruppenbereichen verwalten“ sein.

Erfordert den OAuth 2.0-Bereich chat.admin.memberships.readonly oder chat.admin.memberships.

Wenn Sie Administratorzugriff haben, wird das Auflisten von App-Mitgliedschaften in einem Gruppenbereich nicht unterstützt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort auf die Auflistung der Mitgliedschaften des Gruppenbereichs.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Felder
memberships[]

object (Membership)

Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite.
nextPageToken

string

Ein Token, das Sie als pageToken senden können, um die nächste Ergebnisseite abzurufen. Ist das Feld leer, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.