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 |
Erforderlich. Der Ressourcenname des Gruppenbereichs, für den eine Mitgliederliste abgerufen werden soll. Format: Leerzeichen/{Leerzeichen} |
Abfrageparameter
Parameter | |
---|---|
pageSize |
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 |
pageToken |
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 |
Optional. Ein Abfragefilter. Sie können Mitgliedschaften nach der Rolle ( Wenn Sie nach Rolle filtern möchten, setzen Sie Um nach Typ zu filtern, setzen Sie Verwenden Sie den Operator
Die folgenden Abfragen sind beispielsweise gültig:
Die folgenden Abfragen sind ungültig:
Ungültige Abfragen werden vom Server mit dem Fehler |
showGroups |
Optional. Bei |
showInvited |
Optional. Bei Erfordert derzeit eine Nutzerauthentifizierung. |
useAdminAccess |
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 Das Auflisten von App-Mitgliedschaften in einem Gruppenbereich wird bei Verwendung von Administratorzugriff nicht unterstützt. |
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 ( |
Felder | |
---|---|
memberships[] |
Unsortierte Liste. Liste der Mitgliedschaften auf der angeforderten (oder ersten) Seite. |
nextPageToken |
Ein Token, das Sie als |
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.