Auf dieser Seite erfahren Sie, wie Sie Google Groups mit der Directory API verwalten:
- Gruppe erstellen
- Gruppe aktualisieren
- Gruppenalias hinzufügen
- Gruppe abrufen
- Alle Gruppen für eine Domain oder das Konto abrufen
- Alle Gruppen für ein Mitglied abrufen
- Alle Gruppenaliasse abrufen
- Gruppenalias löschen
- Gruppe löschen
Gruppe erstellen
Verwenden Sie zum Erstellen einer Gruppe die folgende POST
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.
Sie können eine Gruppe für jede Domain erstellen, die mit dem Konto verknüpft ist. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der Methode groups.insert
.
POST https://admin.googleapis.com/admin/directory/v1/groups
Die folgende JSON-Anfrage zeigt einen Beispiel-Anfragetext zum Erstellen einer Gruppe. Die E-Mail-Adresse der Gruppe lautet sales_group@example.com:
{ "email": "sales_group@example.com", "name": "Sales Group", "description": "This is the Sales group." }
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 201
und die Attribute für die neue Gruppe zurückgegeben.
Gruppe aktualisieren
Verwenden Sie zum Aktualisieren der Einstellungen einer Gruppe die folgende PUT
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.
groupKey
ist die E-Mail-Adresse der Gruppe, eine beliebige E-Mail-Adresse des Gruppenalias oder die eindeutige id
der Gruppe. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der Methode groups.update
.
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey
Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.
Im folgenden Beispiel ist die eindeutige groupKey
nnn
und der Name der Gruppe lautet „APAC Sales Group“:
PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn
{ "email": "sales_group@example.com", "name": "APAC Sales Group" }
Bei einer Aktualisierungsanfrage reicht es aus, wenn Sie darin nur die aktualisierten Informationen einreichen. Sie müssen in der Anfrage nicht alle Attribute der Gruppe eingeben.
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 201
und die Attribute für die neue Gruppe zurückgegeben:
{ "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "APAC Sales Group", "directMembersCount": "5", "description": "This is the APAC sales group.", "adminCreated": true, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }
Gruppenalias hinzufügen
Verwenden Sie die folgende POST
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung hinzu, um einen Gruppenalias hinzuzufügen.
groupKey
ist die E-Mail-Adresse der Gruppe, eine der E-Mail-Adressen des Gruppenalias oder die eindeutige id
der Gruppe. Informationen zu den Attributen Abfragestrings, Anfrage und Antwort finden Sie in der Ressource groups
.
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases
Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.
Die folgende JSON-Anfrage zeigt eine Beispielanfrage zum Erstellen eines Gruppenalias. groupKey
ist die eindeutige id
der Gruppe, die durch NNNN
dargestellt wird
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases
{ "alias": "best_sales_group@example.com" }
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 201
und die Attribute für den neuen Gruppenalias zurückgegeben.
Gruppe abrufen
Verwenden Sie zum Abrufen einer Gruppe die folgendeGET
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.
groupKey
ist die E-Mail-Adresse der Gruppe, eine der E-Mail-Adressen des Gruppenalias oder die eindeutige id
der Gruppe. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der Methode groups.get
.
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey
Im Allgemeinen empfiehlt Google, die E-Mail-Adresse der Gruppe nicht als Schlüssel für persistente Daten zu verwenden, da sich die E-Mail-Adresse ändern kann.
Im folgenden Beispiel lautet die eindeutige groupKey
-ID nnnn
:
GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200
und die Gruppeneinstellungen zurückgegeben:
{ "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "APAC Sales Group", "directMembersCount": "5", "description": "This is the APAC sales group.", "adminCreated": true, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }
Alle Gruppen für eine Domain oder das Konto abrufen
Verwenden Sie die folgende GET
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein, um alle Gruppen für eine bestimmte Domain oder das Konto abzurufen. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie in der Methode groups.list
.
Zur besseren Lesbarkeit werden in diesem Beispiel Zeilenumsätze verwendet:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name &customer=my_customer or customerId&pageToken=pagination token &maxResults=max results
Berücksichtigen Sie beim Abrufen aller Gruppen für eine Domain oder das Konto Folgendes:
- Alle Gruppen für eine Subdomain: Verwenden Sie das Argument
domain
mit dem Domainnamen. - Alle Gruppen für das Konto: Verwenden Sie das Argument
customer
mitmy_customer
oder demcustomerId
-Wert des Kontos. Verwenden Sie als Kontoadministrator den Stringmy_customer
für diecustomerId
Ihres Kontos. Wenn Sie Reseller sind und auf das Konto eines Kunden eines Resellers zugreifen, verwenden Sie dafür diecustomerId
. Verwenden Sie für den WertcustomerId
den primären Domainnamen des Kontos in der Anfrage des Vorgangs Alle Nutzer in einer Domain abrufen. Die resultierende Antwort enthält den WertcustomerId
. - Mit dem Argument
domain
undcustomer
: Die Directory API gibt alle Gruppen für dasdomain
zurück. - Ohne die Argumente
domain
undcustomer
: Die Directory API gibt alle Gruppen für das Konto zurück, das mitmy_customer
verknüpft ist. Dies ist das KontocustomerId
des Administrators, von dem die Anfrage stammt. - Mit dem Argument
customer
unduserKey
: Die Directory API gibt einen Fehler zurück. Sie müssen mit diesen Argumenten zwei separate Anfragen senden.
Im folgenden Beispiel fordert ein Kontoadministrator mit my_customer
eine Liste aller Gruppen eines Kontos an:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2
Im folgenden Beispiel gibt die Anfrage eines Reseller-Administrators alle Gruppen für das weiterverkaufte Konto mit dem customerId C03az79cb
zurück. Pro Antwortseite werden maximal 2 Ergebnisse zurückgegeben.
Es gibt ein nextPageToken
für die Folgeliste der Nutzer in dieser Antwort:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 200
und die Gruppen in alphabetischer Reihenfolge der Gruppen-E-Mail zurückgegeben:
{ "kind": "directory#groups", "groups": [ { "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "support@sales.com", "name": "Sales support", "directMembersCount": "6", "description": "The sales support group", "adminCreated": true }, { "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "travel@sales.com", "name": "Sales travel", "directMembersCount": "2", "description": "The travel group supporting sales", "adminCreated": false, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }, "nextPageToken": "NNNN" }
Alle Gruppen für ein Mitglied abrufen
Wenn Sie alle Gruppen abrufen möchten, für die ein Mitglied ein Abo hat, verwenden Sie die folgende GET
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Zur besseren Lesbarkeit werden in diesem Beispiel Zeilenumsätze verwendet:
GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key ?pageToken=pagination token &maxResults=maximum results per response page
- Ein Mitglied kann entweder ein Nutzer oder eine Gruppe sein.
- Bei
userKey
kann es sich um die primäre E-Mail-Adresse des Nutzers, die Alias-E-Mail-Adresse des Nutzers, die primäre E-Mail-Adresse einer Gruppe, den E-Mail-Alias einer Gruppe oder die eindeutigeid
des Nutzers handeln. Diese finden Sie mit dem Vorgang zum Abrufen eines Nutzers. - Der in der
userKey
angegebene Nutzer oder die Gruppe muss zu Ihrer Domain gehören. - Verwenden Sie den Abfragestring
pageToken
für Antworten mit einer großen Anzahl von Gruppen. Im Fall einer Paginierung gibt die Antwort das AttributnextPageToken
zurück, das ein Token für die nächste Seite der Antwortergebnisse liefert. Bei der nächsten Anfrage wird dieses Token als Wert des AbfragestringspageToken
verwendet. - Mit dem Argument
customer
unduserKey
: Die Directory API gibt einen Fehler zurück. Sie müssen mit diesen Argumenten zwei separate Anfragen senden.
Informationen zu den Anfrage- und Antwortattributen finden Sie in der Methode groups.list
.
Bei einer erfolgreichen Antwort werden ein HTTP 200-Statuscode und die Liste der Mitgliedsinformationen zurückgegeben:
- Alle Gruppen, für die ein Mitglied ein Abo hat, einschließlich Gruppen außerhalb der Domain des Nutzers, werden zurückgegeben.
- Die Gruppen werden in der alphabetischen Reihenfolge der E-Mail-Adressen jeder Gruppe zurückgegeben.
- Im Text der Antwort ist
id
die eindeutige ID der Gruppe. - Die Antwort enthält nicht die Aliasse der externen Gruppe in der Liste einer Gruppe, die sich außerhalb der Domain des Nutzers befindet.
{ "kind": "directory#groups", "groups": [ { "kind": "directory#group", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "sale group", "directMembersCount": "5", "description": "Sales group" }, { "kind": "directory#group", "id": "group's unique ID", "etag": "group's unique ETag", "email": "support_group.com", "name": "support group", "directMembersCount": "5", "description": "Support group" } ], "nextPakeToken": "NNNNN" }
Alle Gruppenaliasse abrufen
Wenn Sie alle Aliasse einer Gruppe abrufen möchten, verwenden Sie die folgendeGET
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein. Bei groupKey
kann es sich um die primäre E-Mail-Adresse der Gruppe, die eindeutige id
der Gruppe oder eine E-Mail-Adresse eines Gruppenalias handeln. Informationen zu den Anfrage- und Antwortattributen finden Sie in der Ressource groups
.
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases
Bei einer erfolgreichen Antwort werden der HTTP-Statuscode 201
und eine Liste der Aliasse der Gruppe zurückgegeben.
Gruppenalias löschen
Wenn Sie den Alias einer Gruppe löschen möchten, verwenden Sie die folgendeDELETE
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.
Bei groupKey
kann es sich um die primäre E-Mail-Adresse der Gruppe, die eindeutige id
der Gruppe oder eine E-Mail-Adresse eines Gruppenalias handeln. aliasId
ist der Alias, der gelöscht wird. Informationen zu den Anfrage- und Antwortattributen finden Sie in der Ressource groups
:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 201
zurückgegeben.
Gruppe löschen
Verwenden Sie zum Löschen einer Gruppe die folgende DELETE
-Anfrage und fügen Sie die unter Anfragen autorisieren beschriebene Autorisierung ein.
groupKey
ist der eindeutige id
der Gruppe:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
Mit dieser DELETE
-Anfrage wird beispielsweise die Gruppe mit der Gruppe nnnn
id
gelöscht:
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn
Bei einer erfolgreichen Antwort wird der HTTP-Statuscode 200
zurückgegeben.
Wenn eine Gruppe gelöscht wird, geschieht Folgendes:
- Alle Gruppenmitglieder werden gelöscht. Die Nutzerkonten des Mitglieds werden nicht gelöscht.
- Das Gruppenarchiv wird gelöscht.
- Nachrichten, die an die Adresse der gelöschten Gruppe gesendet werden, werden nicht zugestellt. Stattdessen erhält der Absender eine Unzustellbarkeitsnachricht.