Diese Seite wurde von der Cloud Translation API übersetzt.

Gruppen verwalten

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 die folgende POST-Anfrage und fügen Sie die Autorisierung hinzu, um eine Gruppe zu erstellen. beschrieben in Anfragen autorisieren. Sie können eine Gruppe für jede Domain erstellen, die mit dem Konto verknüpft ist. Für die Abfragezeichenfolgen, request, und Antworteigenschaften, finden Sie groups.insert-Methode.

POST https://admin.googleapis.com/admin/directory/v1/groups

Die folgende JSON-Anfrage zeigt einen Beispielanfragetext zum Erstellen einer Gruppe. E-Mail-Adresse der Gruppe Die Adresse lautet vertrieb_gruppe@beispiel.de:

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 201 und die Eigenschaften für die neue Gruppe.

Gruppe aktualisieren

Um die Einstellungen einer Gruppe zu aktualisieren, verwenden Sie die folgende PUT-Anfrage und fügen Sie den Autorisierung gemäß den Anfragen autorisieren. groupKey ist die E-Mail-Adresse der Gruppe, eine beliebige E-Mail-Adresse des Gruppen-Alias, oder die eindeutige id der Gruppe. Bei den Abfragestrings, Anfrage- und Antwortattributen sieh dir die groups.update-Methode.

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 dauerhafte Daten zu verwenden da die E-Mail-Adresse sich ändern kann.

Im folgenden Beispiel lautet der eindeutige groupKey nnn und der Wert Name ist APAC-Vertriebsgruppe:

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

Bei einer Aktualisierungsanfrage müssen Sie lediglich die aktualisierten Informationen einreichen. Das solltest du nicht tun in der Anfrage alle Eigenschaften der Gruppe eingeben.

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 201 und die Eigenschaften für die neue Gruppe:

{
    "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 Autorisierung hinzu, um einen Gruppenalias hinzuzufügen wie unter Anfragen autorisieren beschrieben. groupKey ist die E-Mail-Adresse der Gruppe, jeder Gruppen-Alias E-Mail-Adresse oder Das eindeutige id der Gruppe. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie unter Die 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 dauerhafte Daten zu verwenden da die E-Mail-Adresse sich ändern kann.

Die folgende JSON-Anfrage zeigt eine Beispielanfrage zum Erstellen eines Gruppenalias. Die groupKey ist die eindeutige id der Gruppe, dargestellt durch NNNN

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 201 und die Eigenschaften des neuen Gruppenalias.

Gruppe abrufen

Verwenden Sie die folgende GET-Anfrage und fügen Sie die Autorisierung hinzu, um eine Gruppe abzurufen beschrieben in Anfragen autorisieren. groupKey ist die E-Mail-Adresse der Gruppe, jeder Gruppen-Alias E-Mail-Adresse oder Das eindeutige id der Gruppe. Informationen zu Abfragestrings, Anfrage- und Antwortattributen finden Sie unter Die 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 dauerhafte Daten zu verwenden da die E-Mail-Adresse sich ändern kann.

Im folgenden Beispiel lautet die eindeutige groupKey-ID nnnn:

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 200 und die Gruppeneinstellungen:

{
    "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 den folgenden GET, um alle Gruppen für eine bestimmte Domain oder das Konto abzurufen anfragen und die in den Anfragen autorisieren. Für die Abfrage Anfrage- und Antworteigenschaften finden Sie in der groups.list-Methode. Zur besseren Lesbarkeit werden in diesem Beispiel Zeilen zurückgegeben:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Beachten 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 Namen der Domain.
Alle Gruppen für das Konto: Verwenden Sie das Argument customer mit einem der folgenden Werte: my_customer oder den customerId-Wert des Kontos. Als Konto Administrator verwenden, verwenden Sie den String my_customer für die customerId. Wenn Sie als Reseller auf das Konto eines Kunden eines Resellers zugreifen, verwenden Sie das customerId des weiterverkauften Kontos. Verwenden Sie für den Wert customerId primären Domainnamen des Kontos in der Alle Nutzer in einer Domain abrufen Anfrage eines Vorgangs. Die resultierende Antwort hat den Wert customerId.
Mit den Argumenten domain und customer: Die Directory API gibt alle Gruppen für domain zurück.
Ohne die Argumente domain und customer: Die Directory API gibt alle Gruppen für das Konto zurück, das mit my_customer Dies ist das Konto customerId des Administrators, der der Anfrage.
Mit den Argumenten customer und userKey: Die Directory API gibt einen Fehler zurück. Sie müssen zwei separate Anfragen mit diesen Argumente.

Im folgenden Beispiel fordert ein Kontoadministrator mit my_customer eine Liste aller Gruppen eines Kontos:

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 zurück mit dem customerId C03az79cb. Pro Antwortseite werden maximal 2 Ergebnisse zurückgegeben. Es gibt 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

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 200 und die Gruppen in alphabetischer Reihenfolge der Gruppen-E-Mail-Adresse:

{
"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

Verwenden Sie den folgenden GET, um alle Gruppen abzurufen, für die ein Mitglied ein Abo hat. anfragen und die in den Anfragen autorisieren. Zur besseren Lesbarkeit In diesem Beispiel werden folgende Zeilen zurückgegeben:

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.
Die userKey kann 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 den eindeutigen id des Nutzers Diese finden Sie im Nutzervorgang abrufen
Der in 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 der Paginierung wird in der Antwort das Attribut nextPageToken zurückgegeben, das ein Token für die nächste Seite der Antwortergebnisse. In Ihrer nächsten Anfrage wird dieses Token als Wert des Abfragestrings pageToken.
Mit den Argumenten customer und userKey: Die Directory API gibt einen Fehler zurück. Sie müssen zwei separate Anfragen mit diesen Argumente.

Informationen zu den Anfrage- und Antwortattributen finden Sie in der groups.list-Methode.

Eine erfolgreiche Antwort gibt eine HTTP 200-Statuscode und die Liste der Mitgliederinformationen:

Alle Gruppen, für die ein Mitglied ein Abo hat, einschließlich Gruppen außerhalb des Domain, 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.
In der Antwort enthält die Liste einer Gruppe außerhalb der Domain des Nutzers nicht den Gruppen-Aliasnamen hinzufügen.

{
    "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

Um alle Aliasse einer Gruppe abzurufen, verwenden Sie die folgende GET-Anfrage und fügen Sie den Autorisierung gemäß den Anfragen autorisieren. Die groupKey kann die primäre E-Mail-Adresse der Gruppe sein, die eindeutige id oder eines der Gruppen-Aliasse E-Mails. Informationen zu den Anfrage- und Antwortattributen finden Sie unter Die Ressource groups.

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 201 und eine Liste der Aliasse der Gruppe.

Gruppenalias löschen

Um den Alias einer Gruppe zu löschen, verwenden Sie die folgende DELETE-Anfrage und fügen Sie den Autorisierung gemäß den Anfragen autorisieren. Die groupKey kann die primäre E-Mail-Adresse der Gruppe sein, die eindeutige id oder eines der Gruppen-Aliasse E-Mails. aliasId ist der Alias gelöscht. Informationen zu den Anfrage- und Antwortattributen finden Sie in der Ressource groups:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 201.

Gruppe löschen

Verwenden Sie die folgende DELETE-Anfrage und fügen Sie die Autorisierung hinzu, um eine Gruppe zu löschen beschrieben in Anfragen autorisieren. Die groupKey ist die eindeutige id der Gruppe:

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Mit der folgenden DELETE-Anfrage wird beispielsweise die Gruppe mit der nnnn-Gruppe id gelöscht:

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Eine erfolgreiche Antwort gibt eine HTTP-Statuscode 200.

Wenn eine Gruppe gelöscht wird, geschieht Folgendes:

Alle Mitglieder der Gruppe werden gelöscht. Die Nutzerkonten des Mitglieds werden nicht gelöscht.
Das Gruppenarchiv wurde gelöscht.
Nachrichten, die an die Adresse der gelöschten Gruppe gesendet werden, werden nicht zugestellt. Stattdessen erhält der Absender Unzustellbarkeitsnachricht.