Class Group

Gruppe

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

Hier sehen Sie ein Beispiel für die Mitglieder einer Gruppe. Ersetzen Sie vor der Ausführung die E-Mail-Adresse mit der Adresse einer Gruppe in Ihrer Domain.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
  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

MethodeRückgabetypKurzbeschreibung
getEmail()StringRuft die E-Mail-Adresse dieser Gruppe ab.
getGroups()Group[]Ruft die direkten untergeordneten Gruppen der Gruppe ab.
getRole(email)RoleRuft die Rolle eines Nutzers im Kontext der Gruppe ab.
getRole(user)RoleRuft die Rolle eines Nutzers im Kontext der Gruppe ab.
getRoles(users)Role[]Ruft die Rollen im Kontext der Gruppe.
getUsers()User[]Ruft die direkten Mitglieder der Gruppe ab, die über ein bekanntes entsprechendes Google-Konto verfügen.
hasGroup(group)BooleanPrüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist.
hasGroup(email)BooleanPrüft, ob eine Gruppe ein direktes Mitglied dieser Gruppe ist.
hasUser(email)BooleanPrüft, ob ein Nutzer ein direktes Mitglied der Gruppe ist.
hasUser(user)BooleanPrüft, 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());
  }
}

Rückflug

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 direkten untergeordneten Gruppen der Gruppe ab. Löst eine Ausnahme aus, wenn Sie keine Berechtigung zum Anzeigen der Mitgliederliste der Gruppe.

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 = "example@googlegroups.com";
  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());
  }
}

Rückflug

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. Nutzer, die direktes Mitglied einer Gruppe sind genau eine Rolle in dieser Gruppe hat. Löst eine Ausnahme aus, wenn der Nutzer kein Mitglied der oder wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe anzuzeigen.

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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

NameTypBeschreibung
emailStringDie E-Mail-Adresse eines Nutzers.

Rückflug

Role: Die 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. Nutzer, die direktes Mitglied einer Gruppe sind genau eine Rolle in dieser Gruppe hat. Löst eine Ausnahme aus, wenn der Nutzer kein Mitglied der oder wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe anzuzeigen.

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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

NameTypBeschreibung
userUserDer Nutzer, dessen Rolle abgerufen werden soll.

Rückflug

Role: Die 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


getRoles(users)

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

In diesem Beispiel werden die Inhaber einer Gruppe aufgelistet:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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

NameTypBeschreibung
usersUser[]Die Nutzer, deren Rollen angefordert werden.

Rückflug

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 über ein bekanntes entsprechendes Google-Konto verfügen. Wirf einen Ausnahme, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe oder die E-Mail-Adressen der Mitglieder anzuzeigen.

Hinweis: Wenn Sie Mitglied einer Gruppe B sind, die wiederum Mitglied einer anderen Gruppe A ist, können Sie die Gruppe A indirekt abonniert haben. Auch wenn Sie Kopien der Nachrichten erhalten, sind Sie also kein Mitglied der übergeordneten Gruppe A.

Hier sehen Sie ein Beispiel für die Mitglieder einer Gruppe. Ersetzen Sie vor der Ausführung die E-Mail-Adresse mit der Adresse einer Gruppe in Ihrer Domain.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  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.

Rückflug

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 true nicht zurück, wenn Die Testgruppe ist mehr als eine Ebene unterhalb dieser Gruppe verschachtelt. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe anzuzeigen.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parameter

NameTypBeschreibung
groupGroupDie Gruppe, deren Mitgliedschaft getestet werden soll.

Rückflug

Boolean: true, wenn die 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 true nicht zurück, wenn Die Testgruppe ist mehr als eine Ebene unterhalb dieser Gruppe verschachtelt. Löst eine Ausnahme aus, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe anzuzeigen.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse einer Gruppe.

Rückflug

Boolean: true, wenn die 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)

Prüft, ob ein Nutzer ein direktes Mitglied der Gruppe ist. Löst eine Ausnahme aus, wenn Sie keine Berechtigung zum Anzeigen der Mitgliederliste der Gruppe.

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

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse eines Nutzers.

Rückflug

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)

Prüft, ob ein Nutzer ein direktes Mitglied der Gruppe ist. Löst eine Ausnahme aus, wenn Sie keine Berechtigung zum Anzeigen der Mitgliederliste der Gruppe.

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

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

Parameter

NameTypBeschreibung
userUserDer Nutzer, dessen Mitgliedschaft getestet werden soll.

Rückflug

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