Method: spaces.members.list

Listet die 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 in der Chat-App, einschließlich der eigenen, werden jedoch nicht berücksichtigt. Wenn Sie die Mitgliedschaften mit Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgeführt, auf die der authentifizierte Nutzer Zugriff hat.

Unterstützt die folgenden Authentifizierungstypen:

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: spaces/{space}

Abfrageparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der Mitgliedschaften, die zurückgegeben werden sollen. 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 der Fehler INVALID_ARGUMENT zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zur Auflistung von Mitgliedschaften empfangen 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.

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 sowohl nach Rolle als auch nach Typ filtern möchten, verwenden Sie den Operator AND. Verwenden Sie den Operator OR, um nach Rolle oder Typ zu filtern.

Entweder member.type = "HUMAN" oder member.type != "BOT" ist erforderlich, wenn useAdminAccess auf „wahr“ festgelegt ist. Andere Filter für den Mitgliedertyp 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. Wenn true, werden neben anderen Mitgliedschaftstypen 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. Wenn true, werden neben anderen Mitgliedschaftstypen auch Mitgliedschaften zurückgegeben, die mit invited-Mitgliedern verknüpft sind. Wenn ein Filter festgelegt ist, werden invited-Kanalmitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

Derzeit ist eine Nutzerauthentifizierung erforderlich.
useAdminAccess

boolean

Optional. Wenn true festgelegt ist, 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 entweder den OAuth 2.0-Bereichchat.admin.memberships.readonly oder chat.admin.memberships.

Die Auflistung von App-Mitgliedschaften in einem Gruppenbereich wird beim Verwenden des Administratorzugriffs 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 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.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.