REST Resource: groups

Ressource: Gruppe

Mit Google Groups können Ihre Nutzer über die E-Mail-Adresse der Gruppe Nachrichten an Gruppen von Personen senden. Weitere Informationen zu gängigen Aufgaben finden Sie im Entwicklerleitfaden.

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

Hinweis: Dem Nutzer, der die API aufruft (oder von einem Dienstkonto imitiert wird), muss eine Rolle zugewiesen sein, die Admin API-Gruppenberechtigungen wie „Super Admin“ oder „Gruppenadministrator“ umfasst.

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-URIs verwendet werden.
email

string

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

string

Der Anzeigename der Gruppe.
description

string

Eine erweiterte Beschreibung, die Nutzern hilft, den Zweck einer Gruppe zu ermitteln. Sie können z. B. angeben, für welche Personen oder Nachrichten diese Gruppe gedacht ist, einen Link zu häufig gestellten Fragen einfügen, ähnliche Gruppen nennen usw. 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 (übergeordnet) ist, werden die Mitglieder der untergeordneten Gruppe nicht in der Property directMembersCount der übergeordneten Gruppe gezählt.
kind

string

Der Typ der API-Ressource. Für Gruppenressourcen ist der Wert admin#directory#group.
etag

string

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 für eine Gruppe hinzufügen, aktualisieren oder entfernen. Wenn sie in der POST- oder PUT-Anfrage einer Gruppe bearbeitet werden, werden die Änderungen ignoriert.
nonEditableAliases[]

string

Schreibgeschützt. Liste der nicht bearbeitbaren Alias-E-Mail-Adressen der Gruppe, die nicht zur primären Domain oder zu den Subdomains des Kontos gehören. Dies sind gültige E-Mail-Adressen, die von der Gruppe verwendet werden. Das ist eine schreibgeschützte Eigenschaft, die in der API-Antwort für eine Gruppe zurückgegeben wird. Wenn sie in der POST- oder PUT-Anfrage einer Gruppe bearbeitet werden, werden die Änderungen ignoriert.

Methoden

delete

 Löscht eine Gruppe.

get

 Ruft die Eigenschaften einer Gruppe ab.

insert

 Erstellt eine Gruppe.

list

 Ruft alle Gruppen einer Domain oder eines Nutzers mit einem Nutzerschlüssel ab (paginiert).

patch

 Aktualisiert die Attribute einer Gruppe.

update

 Aktualisiert die Attribute einer Gruppe.