Objek grup yang anggota dan peran anggotanya dalam grup dapat dikueri.
Berikut adalah contoh yang menampilkan anggota grup. Sebelum menjalankannya, ganti alamat email grup dengan alamat email di domain Anda.
function listGroupMembers() { const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); console.log(`${group.getEmail()}:`); const users = group.getUsers(); for (let i = 0; i < users.length; i++) { const user = users[i]; console.log(user.getEmail()); } }
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
get | String | Mendapatkan alamat email grup ini. |
get | Group[] | Mengambil grup turunan langsung dari grup. |
get | Role | Mengambil peran pengguna dalam konteks grup. |
get | Role | Mengambil peran pengguna dalam konteks grup. |
get | Role[] | Mengambil peran pengguna dalam konteks grup. |
get | User[] | Mendapatkan anggota langsung grup yang memiliki Akun Google terkait yang diketahui. |
has | Boolean | Menguji apakah grup adalah anggota langsung grup ini. |
has | Boolean | Menguji apakah grup adalah anggota langsung grup ini. |
has | Boolean | Menguji apakah pengguna adalah anggota langsung grup. |
has | Boolean | Menguji apakah pengguna adalah anggota langsung grup. |
Dokumentasi mendetail
get Email()
Mendapatkan alamat email grup ini.
Contoh ini mencantumkan alamat email semua grup tempat pengguna tergabung.
function listMyGroupEmails() { const groups = GroupsApp.getGroups(); for (let i = 0; i < groups.length; i++) { console.log(groups[i].getEmail()); } }
Pulang pergi
String
— Alamat email grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
get Groups()
Mengambil grup turunan langsung dari grup. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Selain metode ini, Anda dapat menggunakan layanan lanjutan Admin SDK Directory untuk mengambil anggota grup di domain.
function listGroupMembers() { const GROUP_EMAIL = 'example@googlegroups.com'; 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()); } }
Pulang pergi
Group[]
— Semua grup turunan langsung dari grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
get Role(email)
Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung grup hanya memiliki satu peran dalam grup tersebut. Menampilkan pengecualian jika pengguna bukan anggota grup atau jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Contoh ini mencantumkan pemilik grup:
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); 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
Nama | Jenis | Deskripsi |
---|---|---|
email | String | Alamat email pengguna. |
Pulang pergi
Role
— Peran pengguna tersebut dalam grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
get Role(user)
Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung grup hanya memiliki satu peran dalam grup tersebut. Menampilkan pengecualian jika pengguna bukan anggota grup atau jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Contoh ini mencantumkan pemilik grup:
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); 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
Nama | Jenis | Deskripsi |
---|---|---|
user | User | Pengguna yang perannya akan diambil. |
Pulang pergi
Role
— Peran pengguna tersebut dalam grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
Lihat juga
get Roles(users)
Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung grup hanya memiliki satu peran dalam grup tersebut. Menampilkan pengecualian jika pengguna bukan anggota grup atau jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Contoh ini mencantumkan pemilik grup:
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); 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
Nama | Jenis | Deskripsi |
---|---|---|
users | User[] | Pengguna yang perannya diminta. |
Pulang pergi
Role[]
— Peran pengguna tersebut dalam grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
get Users()
Mendapatkan anggota langsung dan anggota yang diblokir dari grup yang memiliki Akun Google yang sesuai. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup atau email anggota.
Catatan: jika Anda adalah anggota grup B yang merupakan anggota grup A lainnya, Anda secara tidak langsung berlangganan grup A. Meskipun Anda menerima salinan pesan yang dikirim ke grup tersebut, Anda sebenarnya tidak berlangganan grup induk A.
Berikut adalah contoh yang menampilkan anggota grup. Sebelum menjalankannya, ganti alamat email grup dengan alamat email di domain Anda.
function listGroupMembers() { const GROUP_EMAIL = 'example@googlegroups.com'; 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()); } }
Pulang pergi
User[]
— Semua anggota langsung grup.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
has Group(group)
Menguji apakah grup adalah anggota langsung grup ini. Metode ini tidak menampilkan true
jika
grup yang diuji disusun bertingkat lebih dari satu tingkat di bawah grup ini. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); const childGroup = GroupsApp.getGroupByEmail('childgroup@googlegroups.com'); if (group.hasGroup(childGroup)) { console.log('childgroup@googlegroups.com is a child group'); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
group | Group | Grup yang keanggotaannya akan diuji. |
Pulang pergi
Boolean
— true
jika grup tersebut adalah grup turunan dari grup ini; false
jika tidak.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
has Group(email)
Menguji apakah grup adalah anggota langsung grup ini. Metode ini tidak menampilkan true
jika
grup yang diuji disusun bertingkat lebih dari satu tingkat di bawah grup ini. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); if (group.hasGroup('childgroup@googlegroups.com')) { console.log('childgroup@googlegroups.com is a child group'); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
email | String | Alamat email grup. |
Pulang pergi
Boolean
— true
jika grup tersebut adalah grup turunan dari grup ini; false
jika tidak.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
has User(email)
Menguji apakah pengguna adalah anggota langsung grup. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Berikut adalah contoh yang memeriksa apakah pengguna saat ini adalah anggota grup:
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); const currentUser = Session.getActiveUser(); if (group.hasUser(currentUser.getEmail())) { console.log('You are a member'); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
email | String | Alamat email pengguna. |
Pulang pergi
Boolean
— true
jika pengguna tersebut adalah anggota grup; false
jika tidak.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups
has User(user)
Menguji apakah pengguna adalah anggota langsung grup. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.
Berikut adalah contoh yang memeriksa apakah pengguna saat ini adalah anggota grup:
const group = GroupsApp.getGroupByEmail('example@googlegroups.com'); const currentUser = Session.getActiveUser(); if (group.hasUser(currentUser)) { console.log('You are a member'); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
user | User | Pengguna yang keanggotaannya akan diuji. |
Pulang pergi
Boolean
— true
jika pengguna tersebut adalah anggota grup; false
jika tidak.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/groups