Class Group

Group

Objek grup yang peran anggotanya dan anggota tersebut dalam grup dapat dikueri.

Berikut adalah contoh yang menunjukkan anggota grup. Sebelum menjalankannya, ganti alamat email grup dengan alamat email di domain Anda.

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("[e-mail]");
  console.log(group.getEmail() + ':');
  var users = group.getUsers();
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
getEmail()	String	Mendapatkan alamat email grup ini.
getGroups()	Group[]	Mengambil grup turunan langsung dari grup.
getRole(email)	Role	Mengambil peran pengguna dalam konteks grup.
getRole(user)	Role	Mengambil peran pengguna dalam konteks grup.
getRoles(users)	Role[]	Mengambil peran pengguna dalam konteks grup.
getUsers()	User[]	Mendapatkan anggota langsung grup yang memiliki Akun Google terkait yang diketahui.
hasGroup(group)	Boolean	Menguji apakah grup merupakan anggota langsung grup ini.
hasGroup(email)	Boolean	Menguji apakah grup merupakan anggota langsung grup ini.
hasUser(email)	Boolean	Menguji apakah pengguna adalah anggota langsung grup.
hasUser(user)	Boolean	Menguji apakah pengguna adalah anggota langsung grup.

Dokumentasi mendetail

getEmail()

Mendapatkan alamat email grup ini.

Contoh ini mencantumkan alamat email semua grup tempat pengguna berada.

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

Return

String — Alamat email grup.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

getGroups()

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 Direktori Admin SDK untuk mengambil anggota grup di domain.

function listGroupMembers() {
  var GROUP_EMAIL = "[e-mail]";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var childGroups = group.getGroups();
  console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:");
  for (var i = 0; i < childGroups.length; i++) {
    var childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

Return

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

---

getRole(email)

Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung suatu grup memiliki tepat 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:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

Parameter

Nama	Jenis	Deskripsi
email	String	Alamat email pengguna.

Return

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

---

getRole(user)

Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung suatu grup memiliki tepat 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:

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

Return

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

• getRole(email)

---

getRoles(users)

Mengambil peran pengguna dalam konteks grup. Pengguna yang merupakan anggota langsung suatu grup memiliki tepat satu peran dalam grup tersebut. Menampilkan pengecualian jika ada pengguna yang bukan anggota grup, atau jika Anda tidak memiliki izin untuk melihat daftar anggota grup.

Contoh ini mencantumkan pemilik grup:

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

Return

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

---

getUsers()

Mendapatkan anggota langsung grup yang memiliki Akun Google terkait yang diketahui. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup atau email anggota.

Catatan: jika Anda menjadi anggota grup B yang juga merupakan anggota grup A lain, berarti Anda secara tidak langsung berlangganan grup A. Meskipun Anda menerima salinan pesan yang dikirim ke sana, Anda sebenarnya tidak berlangganan grup induk A.

Berikut adalah contoh yang menunjukkan anggota grup. Sebelum menjalankannya, ganti alamat email grup dengan alamat email di domain Anda.

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

Selain metode ini, Anda dapat menggunakan layanan lanjutan Direktori Admin SDK untuk mengambil anggota grup di domain.

Return

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

---

hasGroup(group)

Menguji apakah grup merupakan anggota langsung grup ini. Metode ini tidak akan menampilkan true jika grup yang diuji disusun bertingkat lebih dari satu level di bawah grup ini. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.

var group = GroupsApp.getGroupByEmail("[e-mail]");
var childGroup = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup(childGroup)) {
  console.log("[e-mail] is a child group");
}

Parameter

Nama	Jenis	Deskripsi
group	Group	Grup yang keanggotaannya akan diuji.

Return

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

---

hasGroup(email)

Menguji apakah grup merupakan anggota langsung grup ini. Metode ini tidak akan menampilkan true jika grup yang diuji disusun bertingkat lebih dari satu level di bawah grup ini. Menampilkan pengecualian jika Anda tidak memiliki izin untuk melihat daftar anggota grup.

var group = GroupsApp.getGroupByEmail("[e-mail]");
if (group.hasGroup("[e-mail]")) {
  console.log("[e-mail] is a child group");
}

Parameter

Nama	Jenis	Deskripsi
email	String	Alamat email grup.

Return

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

---

hasUser(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:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

Parameter

Nama	Jenis	Deskripsi
email	String	Alamat email pengguna.

Return

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

---

hasUser(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:

var group = GroupsApp.getGroupByEmail("[e-mail]");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

Parameter

Nama	Jenis	Deskripsi
user	User	Pengguna yang keanggotaannya akan diuji.

Return

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