Class GroupsApp
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
AplikasiGrup
Class ini memberikan akses ke informasi Google Grup. ID ini dapat digunakan untuk membuat kueri informasi seperti alamat email grup, atau daftar grup tempat pengguna adalah anggota langsung.
Berikut adalah contoh yang menunjukkan jumlah grup yang menjadi anggota pengguna saat ini:
const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);
Properti
| Properti | Jenis | Deskripsi |
Role | Role | |
Metode
| Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
getGroupByEmail(email) | Group | Mengambil grup yang memiliki alamat email yang ditentukan. |
getGroups() | Group[] | Mengambil semua grup yang anggota langsungnya adalah Anda (atau anggota yang tertunda). |
Dokumentasi mendetail
getGroupByEmail(email)
Mengambil grup yang memiliki alamat email yang ditentukan. Menampilkan pengecualian jika grup tidak ada atau jika Anda tidak memiliki izin untuk melihatnya.
Berikut adalah contoh yang mendapatkan grup berdasarkan alamat emailnya dan menampilkan apakah pengguna saat ini merupakan anggota. Sebelum menjalankan, ganti alamat email contoh dengan email grup yang sebenarnya.
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
| Nama | Jenis | Deskripsi |
email | String | Alamat email grup yang akan diambil. |
Pulang pergi
Group — Grup dengan alamat email yang ditentukan.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
getGroups()
Mengambil semua grup yang anggota langsungnya adalah Anda (atau anggota yang tertunda). Daftar ini adalah
daftar kosong jika Anda tidak berada dalam grup apa pun. Menampilkan pengecualian jika grup tidak ada atau jika
Anda tidak memiliki izin untuk melihatnya.
Berikut adalah contoh cara mencetak alamat email untuk setiap grup yang diikuti pengguna:
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);
}
Perhatikan bahwa jika Anda adalah anggota grup, B, yang merupakan anggota grup lain, A, maka
Anda
secara tidak langsung berlangganan grup A. Meskipun Anda menerima salinan pesan
yang dikirim ke grup "induk" A, Anda sebenarnya tidak berlangganan grup tersebut.
Anda dapat menggunakan Group.getRole(email) untuk menentukan apakah Anda adalah anggota grup yang ditampilkan yang sudah ada atau tertunda.
Pulang pergi
Group[] — Daftar grup tempat pengguna adalah anggota langsung.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-07-26 UTC.
[null,null,["Terakhir diperbarui pada 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`"]]
