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 gängigen 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 von einem Dienstkonto übernommen wird, muss eine zugewiesene Rolle mit Admin API-Gruppenberechtigungen vorhanden sein, z. B. „Super Admin“ oder „Gruppenadministrator“.

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

E-Mail-Adresse der Gruppe Wenn Ihr Konto mehrere Domains hat, wählen Sie die entsprechende Domain für die E-Mail-Adresse aus. email muss eindeutig sein. Diese Property ist erforderlich, wenn eine Gruppe erstellt wird. Für E-Mail-Adressen von Gruppen gelten dieselben Zeichenregeln wie für Nutzernamen. Weitere Informationen
name

string

Der Anzeigename der Gruppe.
description

string

Eine ausführliche Beschreibung, mit der Nutzer den Zweck einer Gruppe leichter erkennen können. Sie können beispielsweise Informationen darüber hinzufügen, wer der Gruppe beitreten sollte, welche Arten von Nachrichten an die Gruppe gesendet werden sollen, Links zu häufig gestellten Fragen zur Gruppe oder ähnliche 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 die Mitglieder der untergeordneten Gruppe nicht in der Eigenschaft directMembersCount der übergeordneten Gruppe gezählt.
kind

string

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

string

ETag der Ressource.
aliases[]

string

Schreibgeschützt. Die Liste der Alias-E-Mail-Adressen einer Gruppe. Verwenden Sie die Methoden groups.aliases, um Aliasse einer Gruppe hinzuzufügen, zu aktualisieren oder zu entfernen. Wenn sie in der POST- oder PUT-Anfrage einer Gruppe bearbeitet werden, 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 der Subdomains des Kontos befinden. Dies sind funktionierende 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 in der POST- oder PUT-Anfrage einer Gruppe bearbeitet werden, wird die Änderung 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 userKey (paginiert) ab.

patch

 Aktualisiert die Eigenschaften einer Gruppe.

update

 Aktualisiert die Eigenschaften einer Gruppe.