REST Resource: groups

Ressource: Gruppe

Mit Google Groups haben Ihre Nutzer die Möglichkeit, über die E-Mail-Adresse der Gruppe Nachrichten an Personengruppen zu senden. Weitere Informationen zu häufigen Aufgaben finden Sie im Entwicklerhandbuch.

Informationen zu anderen Gruppentypen finden Sie in der Dokumentation zur Cloud Identity Groups API.

Hinweis: Dem Nutzer, der die API aufruft oder dessen Identität durch ein Dienstkonto übernommen wird, muss eine Rolle mit Admin API-Gruppenberechtigungen zugewiesen sein, z. B. Super Admin oder Groups Admin.

JSON-Darstellung 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Felder
id

string

Schreibgeschützt. Die eindeutige ID einer Gruppe. Eine Gruppe id kann als groupKey eines Gruppenanfrage-URI verwendet werden.
email

string

Die E-Mail-Adresse der Gruppe. Wenn Ihr Konto mehrere Domains hat, wählen Sie die entsprechende Domain für die E-Mail-Adresse aus. Die email muss eindeutig sein. Diese Property ist beim Erstellen einer Gruppe erforderlich. E-Mail-Adressen von Gruppen unterliegen denselben Regeln für die Verwendung von Zeichen wie Nutzernamen. Weitere Informationen finden Sie in der Hilfe.
name

string

Der Anzeigename der Gruppe.
description

string

Eine erweiterte Beschreibung, anhand derer Nutzende den Zweck einer Gruppe erkennen können. Sie können beispielsweise Informationen dazu einfügen, wer der Gruppe beitreten soll, welche Arten von Nachrichten an die Gruppe gesendet werden sollen, Links zu häufig gestellten Fragen zur Gruppe oder verwandte Gruppen. Die maximale Länge beträgt 4,096 Zeichen.
adminCreated

boolean

Schreibgeschützt. Der Wert ist true, wenn diese Gruppe von einem Administrator und nicht von einem Nutzer erstellt wurde.
directMembersCount

string (int64 format)

Die Anzahl der Nutzer, die direkte Mitglieder der Gruppe sind. Wenn eine Gruppe Mitglied (untergeordnet) dieser Gruppe (der übergeordneten Gruppe) ist, werden Mitglieder der untergeordneten Gruppe nicht in der Property directMembersCount der übergeordneten Gruppe gezählt.
kind

string

Der Typ der API-Ressource. Für Google Groups-Ressourcen lautet der Wert admin#directory#group.
etag

string

Das ETag der Ressource.
aliases[]

string

Schreibgeschützt. Die Liste der Alias-E-Mail-Adressen einer Gruppe. Mit den groups.aliases-Methoden können Sie Aliasse einer Gruppe hinzufügen, aktualisieren oder entfernen. Wenn Sie eine Änderung in der POST- oder PUT-Anfrage einer Gruppe vornehmen, wird die Änderung ignoriert.
nonEditableAliases[]

string

Schreibgeschützt. Die Liste der nicht bearbeitbaren Alias-E-Mail-Adressen der Gruppe, die sich außerhalb der primären Domain oder Subdomains des Kontos befinden. Dies sind funktionsfähige E-Mail-Adressen, die von der Gruppe verwendet werden. Dies ist eine schreibgeschützte Eigenschaft, die in der API-Antwort für eine Gruppe zurückgegeben wird. Wenn Sie eine Änderung in der POST- oder PUT-Anfrage einer Gruppe vornehmen, wird die Änderung ignoriert.

Methoden

delete

 Löscht eine Gruppe.

get

 Ruft die Attribute einer Gruppe ab.

insert

 Erstellt eine Gruppe.

list

 Ruft alle Gruppen einer Domain oder eines Nutzers mit einem userKey (paginiert) ab.

patch

 Aktualisiert die Eigenschaften einer Gruppe.

update

 Aktualisiert die Eigenschaften einer Gruppe.