Class GroupsApp

GroupsApp

Diese Klasse bietet Zugriff auf Google Groups-Informationen. Sie kann verwendet werden, um Informationen wie die E-Mail-Adresse einer Gruppe oder die Liste der Gruppen abzufragen, in denen der Nutzer ein direktes Mitglied ist.

Hier ein Beispiel, das zeigt, in wie vielen Gruppen der aktuelle Nutzer Mitglied ist:

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

Properties

AttributTypBeschreibung
RoleRole

Methoden

MethodeRückgabetypKurzbeschreibung
getGroupByEmail(email)GroupRuft die Gruppe mit der angegebenen E-Mail-Adresse ab.
getGroups()Group[]Ruft alle Gruppen ab, in denen Sie ein direktes Mitglied (oder ein ausstehendes Mitglied) sind.

Detaillierte Dokumentation

getGroupByEmail(email)

Ruft die Gruppe mit der angegebenen E-Mail-Adresse ab. Löst eine Ausnahme aus, wenn die Gruppe nicht vorhanden ist oder Sie keine Berechtigung haben, sie zu sehen.

Hier ein Beispiel, in dem eine Gruppe anhand ihrer E-Mail-Adresse abgerufen wird und ausgegeben wird, ob der aktuelle Nutzer Mitglied ist. Ersetzen Sie vor der Ausführung die Beispiel-E-Mail-Adresse durch die E-Mail-Adresse einer echten Gruppe.

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  Logger.log('You are a member of this group.');
} else {
  Logger.log('You are not a member of this group.');
}

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse der Gruppe, die abgerufen werden soll.

Rückflug

Group : Die Gruppe mit der angegebenen E-Mail-Adresse.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getGroups()

Ruft alle Gruppen ab, in denen Sie ein direktes Mitglied (oder ein ausstehendes Mitglied) sind. Wenn Sie in keiner Gruppe sind, ist dies eine leere Liste. Löst eine Ausnahme aus, wenn die Gruppe nicht vorhanden ist oder Sie keine Berechtigung haben, sie zu sehen.

Hier ein Beispiel, wie Sie die E-Mail-Adresse für jede Gruppe ausgeben können, der der Nutzer angehört:

function showMyGroups() {
  const groups = GroupsApp.getGroups();
  let str = `You are in ${groups.length} groups: `;
  for (let i = 0; i < groups.length; i++) {
    const group = groups[i];
    str = `${str + group.getEmail()} `;
  }
  Logger.log(str);
}
Wenn Sie Mitglied einer Gruppe B sind, die selbst Mitglied einer anderen Gruppe A ist, sind Sie indirekt in Gruppe A abonniert. Sie erhalten zwar Kopien von Nachrichten, die an die „übergeordnete“ Gruppe A gesendet werden, sind aber nicht tatsächlich in dieser Gruppe abonniert.

Mit Group.getRole(email) können Sie feststellen, ob Sie ein vorhandenes oder ausstehendes Mitglied der zurückgegebenen Gruppen sind.

Rückflug

Group[] : Die Liste der Gruppen, in denen der Nutzer ein direktes Mitglied ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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