Class Group

Gruppe

Ein Gruppenobjekt, dessen Mitglieder und die Rollen dieser Mitglieder innerhalb der Gruppe abgefragt werden können.

Hier ein Beispiel für die Mitglieder einer Gruppe. Bevor Sie ihn ausführen, ersetzen Sie die E-Mail-Adresse der Gruppe durch die E-Mail-Adresse einer Gruppe in Ihrer Domain.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("[e-mail]");
  console.log(group.getEmail() + ':');
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getEmail()	String	Ruft die E-Mail-Adresse dieser Gruppe ab.
getGroups()	Group[]	Ruft die direkt untergeordneten Gruppen der Gruppe ab.
getRole(email)	Role	Ruft die Rolle eines Nutzers im Kontext der Gruppe ab.
getRole(user)	Role	Ruft die Rolle eines Nutzers im Kontext der Gruppe ab.
getRoles(users)	Role[]	Ruft die Rollen der Nutzer im Kontext der Gruppe ab.
getUsers()	User[]	Ruft die direkten Mitglieder der Gruppe ab, die ein bekanntes entsprechendes Google-Konto haben.
hasGroup(group)	Boolean	Prüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist.
hasGroup(email)	Boolean	Prüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist.
hasUser(email)	Boolean	Testet, ob ein Nutzer ein direktes Mitglied der Gruppe ist.
hasUser(user)	Boolean	Testet, ob ein Nutzer ein direktes Mitglied der Gruppe ist.

Detaillierte Dokumentation

getEmail()

Ruft die E-Mail-Adresse dieser Gruppe ab.

In diesem Beispiel werden die E-Mail-Adressen aller Gruppen aufgelistet, zu denen der Nutzer gehört.

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

Return

String: Die E-Mail-Adresse der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

getGroups()

Ruft die direkt untergeordneten Gruppen der Gruppe ab. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

Zusätzlich zu dieser Methode können Sie den erweiterten Dienst Admin SDK Directory verwenden, um Gruppenmitglieder in einer Domain abzurufen.

function listGroupMembers() {
  var GROUP_EMAIL = "[e-mail]";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var childGroups = group.getGroups();
  console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:");
  for (var i = 0; i < childGroups.length; i++) {
    var childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

Return

Group[]: Alle direkt untergeordneten Gruppen der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

getRole(email)

Ruft die Rolle eines Nutzers im Kontext der Gruppe ab. Ein Nutzer, der direktes Mitglied einer Gruppe ist, hat genau eine Rolle innerhalb dieser Gruppe. Löst eine Ausnahme aus, wenn der Nutzer kein Mitglied der Gruppe ist oder Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

Parameter

Name	Typ	Beschreibung
email	String	Die E-Mail-Adresse eines Nutzers.

Return

Role: Rolle dieses Nutzers innerhalb der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

getRole(user)

Ruft die Rolle eines Nutzers im Kontext der Gruppe ab. Ein Nutzer, der direktes Mitglied einer Gruppe ist, hat genau eine Rolle innerhalb dieser Gruppe. Löst eine Ausnahme aus, wenn der Nutzer kein Mitglied der Gruppe ist oder Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

Parameter

Name	Typ	Beschreibung
user	User	Der Nutzer, dessen Rolle abgerufen werden soll.

Return

Role: Rolle dieses Nutzers innerhalb der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

Weitere Informationen

• getRole(email)

---

getRoles(users)

Ruft die Rollen der Nutzer im Kontext der Gruppe ab. Ein Nutzer, der direktes Mitglied einer Gruppe ist, hat genau eine Rolle innerhalb dieser Gruppe. Löst eine Ausnahme aus, wenn ein Nutzer kein Mitglied der Gruppe ist oder wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var users = group.getUsers();
var roles = group.getRoles(users);
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  if (roles[i] == GroupsApp.Role.OWNER) {
    console.log(users[i].getEmail());
  }
}

Parameter

Name	Typ	Beschreibung
users	User[]	Die Nutzer, deren Rollen angefordert werden.

Return

Role[]: Die Rollen dieser Nutzer innerhalb der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

getUsers()

Ruft die direkten Mitglieder der Gruppe ab, die ein bekanntes entsprechendes Google-Konto haben. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe oder die E-Mail-Adressen der Mitglieder anzusehen.

Hinweis: Wenn Sie Mitglied einer Gruppe B sind, die selbst Mitglied einer anderen Gruppe A ist, sind Sie Gruppe A indirekt abonniert. Obwohl Sie Kopien der an sie gesendeten Nachrichten erhalten, sind Sie der übergeordneten Gruppe A nicht beigetreten.

Hier ein Beispiel für die Mitglieder einer Gruppe. Bevor Sie ihn ausführen, ersetzen Sie die E-Mail-Adresse der Gruppe durch die E-Mail-Adresse einer Gruppe in Ihrer Domain.

function listGroupMembers() {
  var GROUP_EMAIL = "[e-mail]";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var users = group.getUsers();
  console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:");
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Zusätzlich zu dieser Methode können Sie den erweiterten Dienst Admin SDK Directory verwenden, um Gruppenmitglieder in einer Domain abzurufen.

Return

User[]: Alle direkten Mitglieder der Gruppe.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

hasGroup(group)

Prüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist. Die Methode gibt nicht true zurück, wenn die getestete Gruppe mehr als eine Ebene unter dieser Gruppe verschachtelt ist. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

var group = GroupsApp.getGroupByEmail("[e-mail]");
var childGroup = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup(childGroup)) {
  console.log("[e-mail] is a child group");
}

Parameter

Name	Typ	Beschreibung
group	Group	Die Gruppe, deren Mitgliedschaft getestet werden soll.

Return

Boolean: true, wenn diese Gruppe eine untergeordnete Gruppe dieser Gruppe ist; andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

hasGroup(email)

Prüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist. Die Methode gibt nicht true zurück, wenn die getestete Gruppe mehr als eine Ebene unter dieser Gruppe verschachtelt ist. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

var group = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup("[e-mail]")) {
  console.log("[e-mail] is a child group");
}

Parameter

Name	Typ	Beschreibung
email	String	E-Mail-Adresse einer Gruppe

Return

Boolean: true, wenn diese Gruppe eine untergeordnete Gruppe dieser Gruppe ist; andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

hasUser(email)

Testet, ob ein Nutzer ein direktes Mitglied der Gruppe ist. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

Im folgenden Beispiel wird geprüft, ob der aktuelle Nutzer Mitglied einer Gruppe ist:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

Parameter

Name	Typ	Beschreibung
email	String	Die E-Mail-Adresse eines Nutzers.

Return

Boolean: true, wenn dieser Nutzer Mitglied der Gruppe ist; andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups

---

hasUser(user)

Testet, ob ein Nutzer ein direktes Mitglied der Gruppe ist. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

Im folgenden Beispiel wird geprüft, ob der aktuelle Nutzer Mitglied einer Gruppe ist:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

Parameter

Name	Typ	Beschreibung
user	User	Der Nutzer, dessen Mitgliedschaft getestet werden soll.

Return

Boolean: true, wenn dieser Nutzer Mitglied der Gruppe ist; andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

• https://www.googleapis.com/auth/groups