Class Group

Gruppe

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

Hier ist ein Beispiel, das die Mitglieder einer Gruppe zeigt. Ersetzen Sie vor der Ausführung die E-Mail-Adresse der Gruppe durch die einer E-Mail-Adresse in Ihrer Domain.

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('[e-mail]');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const 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 direkten 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[]	Hier werden die direkten Mitglieder der Gruppe abgerufen, 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	Prüft, ob ein Nutzer direkt Mitglied der Gruppe ist.
hasUser(user)	Boolean	Prüft, ob ein Nutzer direkt Mitglied der Gruppe ist.

Detaillierte Dokumentation

getEmail()

Ruft die E-Mail-Adresse dieser Gruppe ab.

In diesem Beispiel sind die E-Mail-Adressen aller Gruppen aufgeführt, zu denen der Nutzer gehört.

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

Rückflug

String: E-Mail-Adresse der Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

getGroups()

Ruft die direkten untergeordneten Gruppen der Gruppe ab. Es wird eine Ausnahme ausgelöst, 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() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const childGroups = group.getGroups();
  console.log(`Group ${GROUP_EMAIL} has ${childGroups.length} groups:`);
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

Rückflug

Group[]: Alle direkten untergeordneten Gruppen der Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

getRole(email)

Ruft die Rolle eines Nutzers im Kontext der Gruppe ab. Ein Nutzer, der direkt Mitglied einer Gruppe ist, hat genau eine Rolle in dieser Gruppe. Es wird eine Ausnahme ausgelöst, 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:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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.

Rückflug

Role: Die Rolle des Nutzers in der Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

getRole(user)

Ruft die Rolle eines Nutzers im Kontext der Gruppe ab. Ein Nutzer, der direkt Mitglied einer Gruppe ist, hat genau eine Rolle in dieser Gruppe. Es wird eine Ausnahme ausgelöst, 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:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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.

Rückflug

Role: Die Rolle des Nutzers in der Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 direkt Mitglied einer Gruppe ist, hat genau eine Rolle in dieser Gruppe. Es wird eine Ausnahme ausgelöst, wenn ein 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:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

getUsers()

Ruft die direkten Mitglieder und gesperrten Mitglieder der Gruppe ab, die ein bekanntes entsprechendes Google-Konto haben. Es wird eine Ausnahme ausgelöst, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe oder die E-Mail-Adressen der Mitglieder aufzurufen.

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

Hier ist ein Beispiel, das die Mitglieder einer Gruppe zeigt. Ersetzen Sie vor der Ausführung die E-Mail-Adresse der Gruppe durch die einer E-Mail-Adresse in Ihrer Domain.

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

Neben dieser Methode können Sie auch den erweiterten Dienst Admin SDK Directory verwenden, um Gruppenmitglieder in einer Domain abzurufen.

Rückflug

User[] – Alle direkten Mitglieder der Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 getestete Gruppe mehr als eine Ebene unterhalb dieser Gruppe verschachtelt ist. Es wird eine Ausnahme ausgelöst, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 getestete Gruppe mehr als eine Ebene unterhalb dieser Gruppe verschachtelt ist. Es wird eine Ausnahme ausgelöst, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

const 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

hasUser(email)

Prüft, ob ein Nutzer direkt Mitglied der Gruppe ist. Es wird eine Ausnahme ausgelöst, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

Hier ein Beispiel, in dem geprüft wird, ob der aktuelle Nutzer Mitglied einer Gruppe ist:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

---

hasUser(user)

Prüft, ob ein Nutzer direkt Mitglied der Gruppe ist. Es wird eine Ausnahme ausgelöst, wenn Sie nicht berechtigt sind, die Mitgliederliste der Gruppe aufzurufen.

Hier ein Beispiel, in dem geprüft wird, ob der aktuelle Nutzer Mitglied einer Gruppe ist:

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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