Mit der Methode groups.list der Directory API können Sie nach Gruppen suchen, die bestimmten Attributen entsprechen. Diese Methode akzeptiert den Parameter query, der eine Suchanfrage mit einer oder mehreren Suchklauseln kombiniert. Jede Suchklausel besteht aus drei Teilen:
- Feld
- Gruppenattribut, nach dem gesucht wird. Beispiel:
name. - Operator
- Test, der an den Daten ausgeführt wird, um eine Übereinstimmung zu finden. Mit dem Operator
=wird beispielsweise geprüft, ob ein Textattribut mit einem Wert übereinstimmt. - Wert
- Der Inhalt des Attributs, das getestet wird. Beispiel:
groupName.
Mehrere Klauseln werden durch Leerzeichen getrennt und implizit durch einen AND-Operator verknüpft.
Felder
| Feld | Werttyp | Operatoren | Beschreibung |
|---|---|---|---|
email |
String | =, :{PREFIX}* |
Die E-Mail-Adresse der Gruppe. Hinweis: Dieser Parameter kann nicht zusammen mit dem Parameter memberKey in derselben Abfrage verwendet werden. |
name |
String | =, :{PREFIX}* |
Der Anzeigename der Gruppe. Hinweis: Dieser Parameter kann nicht zusammen mit dem Parameter memberKey in derselben Abfrage verwendet werden. |
memberKey |
String | =, |
Der Abfrageparameter memberKey gibt alle Gruppen zurück, in denen ein Nutzer oder eine Gruppe Mitglied ist. Dieser Wert kann die primäre E-Mail-Adresse oder die Alias-E-Mail-Adresse des Nutzers, die primäre E-Mail-Adresse oder die Alias-E-Mail-Adresse einer Gruppe oder die eindeutige ID eines Nutzers sein. Hinweis: Dieser Parameter kann nicht zusammen mit den Parametern email oder name in derselben Abfrage verwendet werden. |
Werttypen
| Werttyp | Hinweise |
|---|---|
| String | Setzen Sie ' in einfache Anführungszeichen, wenn die Abfrage Leerzeichen enthält. Maskieren Sie einfache Anführungszeichen in Abfragen mit \', z. B. 'Valentine\'s Day'. |
Operatoren
| Operator | Unterstützte Werttypen | Hinweise |
|---|---|---|
= |
String, boolescher Wert, Zahl, Datum | Das Feld und der Wert stimmen genau überein. Beispiel: name=contact stimmt mit allen Gruppen mit dem Attribut name "contact" überein, aber nicht mit "contactgroup". Wird für die meisten Stringfelder unterstützt (siehe oben). |
:{PREFIX}* |
String | Das Feld beginnt mit dem Wert. Eine Abfrage mit email:support* stimmt beispielsweise mit Gruppen mit email-Werten von "supportgroup@" und "support@" überein, nicht aber mit "contactsupport". Wird nur für eine begrenzte Anzahl von Stringfeldern unterstützt (siehe oben). |
Beispiele
Für alle Anfragen wird die Methode groups.list verwendet. Die entsprechende HTTP-Anfrage sieht so aus (Zeilenumbrüche zur besseren Lesbarkeit):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Die query-Parameter müssen URL-codiert sein. Die Anfrage query=email:support* wird beispielsweise als query=email%3Asupport* URL-codiert.
In allen Beispielen auf dieser Seite werden nicht codierte query-Parameter verwendet.
Clientbibliotheken übernehmen diese URL-Codierung automatisch.
Nach einer Gruppe anhand des Anzeigenamens suchen
name='contact'
Nach Gruppen suchen, die einem E-Mail-Präfix entsprechen
email:admin*
Nach allen Gruppen eines Nutzers suchen
memberKey=user@company.com
Nach Gruppen mit Namen und E‑Mail-Adressen suchen, die mit „contact“ beginnen
name:contact* email:contact*