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. Die Mitgliedschaften in Chat-Apps werden jedoch nicht aufgeführt, einschließlich ihrer eigenen. Wenn Sie Mitgliedschaften mit der 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 der zurückzugebenden Mitgliedschaften. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Wenn keine Vorgabe erfolgt, werden maximal 100 Mitgliedschaften zurückgegeben.

Der Maximalwert beträgt 1.000. Wenn Sie einen Wert über 1.000 verwenden, wird er automatisch in „1.000“ geändert.

Negative Werte geben den Fehler INVALID_ARGUMENT zurück.

pageToken

string

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

Beim Paginieren sollten alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Die Übergabe verschiedener Werte an die anderen Parameter kann 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, setzen Sie role auf ROLE_MEMBER oder ROLE_MANAGER.

Um nach Typ zu filtern, setzen Sie member.type auf HUMAN oder BOT.

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.

Die folgenden Abfragen sind beispielsweise gültig:

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

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. Bei true werden neben anderen Arten von Mitgliedschaften auch Mitgliedschaften zurückgegeben, die mit einer Google Group verknüpft sind. Wenn filter festgelegt wird, werden keine Google Group-Mitgliedschaften zurückgegeben, die nicht den Filterkriterien entsprechen.

showInvited

boolean

Optional. Bei true werden neben 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.

Erfordert derzeit eine Nutzerauthentifizierung.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort auf eine Liste der Mitgliedschaften des Gruppenbereichs.

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender 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. Wenn das Feld leer ist, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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