Mit der Methode groups.list der Directory API können Sie nach Gruppen suchen, die bestimmten Attributen entsprechen. Diese Methode akzeptiert den Parameter query, bei dem es sich um eine Suchanfrage handelt, die eine oder mehrere Suchklauseln kombiniert. Jede Suchklausel besteht aus drei Teilen:
- Field
- Zu durchsuchendes Gruppenattribut. Beispiel:
name. - Betreiber
- Einen Test, der mit den Daten durchgeführt wird, um eine Übereinstimmung zu erzielen. Beispielsweise testet der Operator
=, 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 verbunden.
Felder
| Field | Werttyp | Operatoren | Beschreibung |
|---|---|---|---|
email |
String | =, :{PREFIX}* |
E-Mail-Adresse der Gruppe Hinweis: Dies kann nicht zusammen mit dem Parameter memberKey in derselben Abfrage verwendet werden. |
name |
String | =, :{PREFIX}* |
Anzeigename der Gruppe Hinweis: Dies kann nicht zusammen mit dem memberKey-Parameter in derselben Abfrage verwendet werden. |
memberKey |
String | =, |
Der Abfrageparameter memberKey gibt alle Gruppen zurück, zu denen ein Nutzer oder eine Gruppe eine Mitgliedschaft hat. Bei diesem Wert kann es sich um die primäre oder Alias-E-Mail-Adresse des Nutzers, die primäre oder Alias-E-Mail-Adresse einer Gruppe oder eine eindeutige Nutzer-ID handeln. Hinweis: Dies kann nicht zusammen mit dem Parameter email oder name in derselben Abfrage verwendet werden. |
Werttypen
| Werttyp | Hinweise |
|---|---|
| String | Setzen Sie ' in einfache Anführungszeichen, wenn die Abfrage Leerzeichen enthält. Verwenden Sie \' in einfachen Anführungszeichen, z. B. 'Valentine\'s Day'. |
Operatoren
| Betreiber | Unterstützte Werttypen | Hinweise |
|---|---|---|
= |
string, boolean, number, date | Das Feld und der Wert stimmen genau überein. name=contact stimmt beispielsweise mit allen Gruppen mit dem name-Attribut "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* gleicht beispielsweise Gruppen mit den email-Werten "supportgroup@" und "support@" ab, aber nicht "contactsupport". Wird nur bei einer begrenzten Anzahl von Stringfeldern unterstützt (siehe oben). |
Beispiele
Bei allen Abfragen wird die Methode groups.list verwendet, für die eine HTTP-Anfrage ähnlich der folgenden ist (Zeilenumbrüche zur besseren Lesbarkeit eingefügt):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
Die query-Parameter müssen URL-codiert sein. Die Abfrage query=email:support* ist beispielsweise URL-codiert als query=email%3Asupport*.
Alle Beispiele auf dieser Seite zeigen nicht codierte query-Parameter.
Clientbibliotheken führen diese URL-Codierung automatisch durch.
Über den Anzeigenamen nach einer Gruppe suchen
name='contact'
Nach Gruppen mit einem 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“ beginnt
name:contact* email:contact*