Method: spaces.members.list

Listet die Mitgliedschaften in einem Gruppenbereich auf. Ein Beispiel finden Sie unter Mitgliedschaften auflisten. Bei der Auflistung von Mitgliedschaften mit App-Authentifizierung werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die die Chat-App Zugriff hat, aber die Mitgliedschaft in Chat-Apps, einschließlich ihrer Mitgliedschaft, ausgenommen. Wenn Sie Mitgliedschaften mit Nutzerauthentifizierung auflisten, werden Mitgliedschaften in Gruppenbereichen aufgelistet, auf die der authentifizierte Nutzer Zugriff hat.

Erfordert Authentifizierung. Unterstützt vollständig die Dienstkontoauthentifizierung und die Nutzerauthentifizierung. Für die Nutzerauthentifizierung ist der Autorisierungsbereich chat.memberships oder chat.memberships.readonly erforderlich.

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 Mitgliedschaftsliste abgerufen werden soll.

Format: Gruppenbereiche/{Leerzeichen}

Abfrageparameter

Parameter
pageSize

integer

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

Wenn keine Angabe erfolgt, 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.

Negative Werte geben den Fehler INVALID_ARGUMENT zurück.
pageToken

string

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

Bei der Paginierung 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 die Kanalmitgliedschaft nach der Rolle eines Mitglieds (role) und Typ (member.type) filtern.

Um nach Rolle zu filtern, setzen Sie role auf ROLE_MEMBER oder ROLE_MANAGER.

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

Mit dem Operator AND können Sie nach Rolle und Typ filtern. Verwenden Sie den Operator OR, um nach einer Rolle oder einem 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 außerdem neben anderen Arten der Mitgliedschaft auch die mit einer Google Group verknüpften Mitgliedschaften zurückgegeben. Wenn filter festgelegt ist, werden Google Group-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

showInvited

boolean

Optional. Bei true werden neben den anderen Arten der Mitgliedschaft auch die mit invited Mitgliedern verbundenen Mitgliedschaften zurückgegeben. Wenn ein Filter festgelegt ist, werden invited-Mitgliedschaften, die nicht den Filterkriterien entsprechen, nicht zurückgegeben.

Derzeit ist eine Nutzerauthentifizierung erforderlich.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:

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

object (Membership)

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 weiteren Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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