Mit der Methode groups.list der Directory API können Sie nach Gruppen suchen, die bestimmten Attributen entsprechen. Für diese Methode ist der Parameter query zulässig. Dabei handelt es sich um eine Suchanfrage, die eine oder mehrere 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 ermitteln. Mit dem Operator
=wird beispielsweise geprüft, ob ein Textattribut mit einem Wert übereinstimmt. - Wert
- Der Inhalt des getesteten Attributs. 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 in derselben Abfrage mit dem Parameter memberKey verwendet werden. |
name |
String | =, :{PREFIX}* |
Der Anzeigename der Gruppe. Hinweis: Dieser Parameter kann nicht in derselben Abfrage mit dem Parameter memberKey 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 der Alias des Nutzers, die primäre E-Mail-Adresse oder der Alias 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 die Abfrage in einfache Anführungszeichen ', wenn sie Leerzeichen enthält. Setzen Sie in Abfragen einfache Anführungszeichen 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 beispielsweise mit allen Gruppen mit dem name-Attribut "contact" überein, aber nicht mit "contactgroup". Wird von den meisten Stringfeldern unterstützt (siehe oben). |
:{PREFIX}* |
String | Das Feld beginnt mit dem Wert. Eine Abfrage mit email:support* stimmt beispielsweise mit Gruppen mit den email-Werten "supportgroup@" und "support@" überein, aber nicht mit "contactsupport". Nur für eine begrenzte Anzahl von Stringfeldern unterstützt (siehe oben). |
Beispiele
Für alle Abfragen wird die Methode groups.list verwendet. Die zugehörige HTTP-Anfrage sieht in etwa 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 Suchanfrage query=email:support* wird beispielsweise als query=email%3Asupport* URL-codiert.
Alle Beispiele auf dieser Seite enthalten nicht codierte query-Parameter.
Clientbibliotheken verarbeiten diese URL-Codierung automatisch.
Nach einer Gruppe anhand des Anzeigenamens suchen
name='contact'
Nach Gruppen mit einem bestimmten E-Mail-Präfix suchen
email:admin*
Nach allen Gruppen eines Nutzers suchen
memberKey=user@company.com
Nach Gruppen suchen, deren Name und E-Mail-Adresse mit „kontakt“ beginnen
name:contact* email:contact*