Class GroupsApp
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Google GroupsApp
Diese Klasse bietet Zugriff auf Google Groups-Informationen. Damit können Informationen wie die E-Mail-Adresse einer Gruppe oder die Liste der Gruppen abgefragt werden, in denen der Nutzer direkt Mitglied ist.
Hier ist 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.`);
Attribute
| Attribut | Typ | Beschreibung |
Role | Role | |
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
getGroupByEmail(email) | Group | Ruft die Gruppe mit der angegebenen E-Mail-Adresse ab. |
getGroups() | Group[] | Hier werden alle Gruppen abgerufen, in denen Sie direkt Mitglied sind (oder deren Beitritt ausstehend ist). |
Detaillierte Dokumentation
getGroupByEmail(email)
Ruft die Gruppe mit der angegebenen E-Mail-Adresse ab. Es wird eine Ausnahme ausgelöst, wenn die Gruppe nicht existiert oder Sie nicht berechtigt sind, sie aufzurufen.
Hier ein Beispiel, in dem eine Gruppe anhand ihrer E-Mail-Adresse abgerufen und ausgegeben wird, ob der aktuelle Nutzer Mitglied ist. Ersetzen Sie vor dem Ausführen 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
| Name | Typ | Beschreibung |
email | String | Die 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/groups
getGroups()
Hier werden alle Gruppen abgerufen, in denen Sie direkt Mitglied sind (oder deren Beitritt ausstehend ist). Wenn Sie in keiner Gruppe sind, ist die Liste leer. Löst eine Ausnahme aus, wenn die Gruppe nicht vorhanden ist oder Sie nicht berechtigt sind, sie aufzurufen.
Hier ein Beispiel dafür, wie Sie die E-Mail-Adresse für jede Gruppe drucken, zu der der Nutzer gehö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 Mitglied von Gruppe A. Auch wenn Sie Kopien von Nachrichten erhalten, die an die übergeordnete Gruppe A gesendet wurden, sind Sie nicht wirklich Mitglied dieser Gruppe.
Mit Group.getRole(email) können Sie feststellen, ob Sie bereits Mitglied einer der zurückgegebenen Gruppen sind oder eine Einladung dazu erhalten haben.
Rückflug
Group[]: Liste der Gruppen, in denen der Nutzer direkt Mitglied ist.
Autorisierung
Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:
-
https://www.googleapis.com/auth/groups
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eThe \u003ccode\u003eGroupsApp\u003c/code\u003e class in Apps Script allows you to access and manage Google Groups information, such as retrieving group details and membership status.\u003c/p\u003e\n"],["\u003cp\u003eYou can use \u003ccode\u003egetGroupByEmail()\u003c/code\u003e to retrieve a specific group by its email address and check if the current user is a member.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetGroups()\u003c/code\u003e retrieves all groups where the user is a direct or pending member, enabling actions like listing group email addresses.\u003c/p\u003e\n"],["\u003cp\u003eBoth methods require authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/groups\u003c/code\u003e scope for accessing Google Groups data.\u003c/p\u003e\n"]]],[],null,["# Class GroupsApp\n\nGroupsApp\n\nThis class provides access to Google Groups information. It can be used to query information such\nas a group's email address, or the list of groups in which the user is a direct member.\n\nHere's an example that shows how many groups the current user is a member of:\n\n```javascript\nconst groups = GroupsApp.getGroups();\nLogger.log(`You belong to ${groups.length} groups.`);\n``` \n\n### Properties\n\n| Property | Type | Description |\n|----------|--------------------------------------------|-------------|\n| `Role` | [Role](/apps-script/reference/groups/role) | |\n\n### Methods\n\n| Method | Return type | Brief description |\n|----------------------------------------------------|------------------------------------------------|----------------------------------------------------------------------------------|\n| [getGroupByEmail(email)](#getGroupByEmail(String)) | [Group](/apps-script/reference/groups/group) | Retrieves the group having the specified email address. |\n| [getGroups()](#getGroups()) | [Group[]](/apps-script/reference/groups/group) | Retrieves all the groups of which you are a direct member (or a pending member). |\n\nDetailed documentation\n----------------------\n\n### `get``Group``By``Email(email)`\n\nRetrieves the group having the specified email address. Throws an exception if the group does\nnot exist or if you do not have permission to see it.\n\nHere is an example that gets a group by its email address and outputs whether the current\nuser is a member. Before running, replace the sample email address with a real group's email.\n\n```javascript\nconst group = GroupsApp.getGroupByEmail('example@googlegroups.com');\nconst currentUser = Session.getActiveUser();\nif (group.hasUser(currentUser)) {\n Logger.log('You are a member of this group.');\n} else {\n Logger.log('You are not a member of this group.');\n}\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|----------|---------------------------------------------|\n| `email` | `String` | The email address of the group to retrieve. |\n\n#### Return\n\n\n[Group](/apps-script/reference/groups/group) --- The group with the specified email address.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/groups`\n\n*** ** * ** ***\n\n### `get``Groups()`\n\nRetrieves all the groups of which you are a direct member (or a pending member). This is an\nempty list if you are not in any groups. Throws an exception if the group does not exist or if\nyou do not have permission to see it.\n\nHere's an example of how to print the email address for every group the user belongs to:\n\n```javascript\nfunction showMyGroups() {\n const groups = GroupsApp.getGroups();\n let str = `You are in ${groups.length} groups: `;\n for (let i = 0; i \u003c groups.length; i++) {\n const group = groups[i];\n str = `${str + group.getEmail()} `;\n }\n Logger.log(str);\n}\n```\nNote that if you are a member of a group, B, which is itself a member of another group, A, then you are *indirectly* subscribed to group A. Even though you receive copies of messages sent to the \"parent\" group A, you are not actually subscribed to that group.\n\nYou can use [Group.getRole(email)](/apps-script/reference/groups/group#getRole(String)) to determine if you are an existing or pending\nmember of the returned groups.\n\n#### Return\n\n\n[Group[]](/apps-script/reference/groups/group) --- The list of groups of which the user is a direct member.\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/groups`"]]
