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 mit App-Authentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgeführt, auf die die Chat-App Zugriff hat. Mitgliedschaften der Chat-App selbst werden jedoch ausgeschlossen. Wenn Sie Mitgliedschaften mit Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Bereichen aufgeführt, auf die der authentifizierte Nutzer Zugriff hat.

Unterstützt die folgenden Arten der Authentifizierung:

  • App-Authentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (erfordert Administratorgenehmigung)

  • Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (nur Gruppenbereiche im Importmodus)
    • Bei der Nutzerauthentifizierung werden Administratorberechtigungen gewährt, wenn ein Administratorkonto authentifiziert wird, useAdminAccess gleich true ist und einer der folgenden Autorisierungsbereiche verwendet wird:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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 Bereichs, für den eine Mitgliederliste abgerufen werden soll.

Format: spaces/{space}

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der zurückzugebenden Mitgliedschaften. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn nicht angegeben, werden maximal 100 Mitgliedschaften zurückgegeben.

Der Höchstwert ist 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in 1.000 geändert.

Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten von Mitgliedschaften empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen.

Beim Paginieren müssen alle anderen bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter unterschiedliche Werte übergeben, kann das zu unerwarteten Ergebnissen führen.
filter

string

Optional. Ein Abfragefilter.

Sie können Mitgliedschaften nach der Rolle (role) und dem Typ (member.type) eines Mitglieds filtern.

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

Wenn Sie nach Typ filtern möchten, legen Sie member.type auf HUMAN oder BOT fest. Sie können auch mit dem Operator != nach member.type filtern.

Wenn Sie nach Rolle und Typ filtern möchten, verwenden Sie den Operator AND. Wenn Sie nach Rolle oder Typ filtern möchten, verwenden Sie den Operator OR.

Entweder member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn useAdminAccess auf „true“ gesetzt ist. Andere Filter für Mitgliedertypen 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 Abfragen werden vom Server mit dem Fehler INVALID_ARGUMENT abgelehnt.
showGroups

boolean

Optional. Wenn true, werden zusätzlich zu anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit einem Google Group verknüpft sind. Wenn ein filter festgelegt ist, werden Google Group-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.
showInvited

boolean

Optional. Wenn true, werden zusätzlich zu anderen Arten von 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.

Derzeit ist eine Nutzerauthentifizierung erforderlich.
useAdminAccess

boolean

Optional. Wenn true, wird die Methode mit den Administratorberechtigungen des Google Workspace-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.

Das Auflisten von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung des Administratorzugriffs nicht unterstützt.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort auf die Anfrage zum Auflisten 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 als pageToken gesendet werden kann, um die nächste Ergebnisseite abzurufen. Wenn das Feld leer ist, 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.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

Weitere Informationen finden Sie im Autorisierungsleitfaden.