Class Group

Grup

Üyelerin ve bu üyelerin grup içindeki rollerinin sorgulanabileceği bir grup nesnesi.

Bir grubun üyelerini gösteren bir örneği aşağıda bulabilirsiniz. Grubu çalıştırmadan önce, grubun e-posta adresini alanınızdaki bir e-posta adresiyle değiştirin.

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

Yöntemler

YöntemDönüş türüKısa açıklama
getEmail()StringBu grubun e-posta adresini alır.
getGroups()Group[]Grubun doğrudan alt gruplarını alır.
getRole(email)RoleGrup bağlamında kullanıcının rolünü alır.
getRole(user)RoleGrup bağlamında kullanıcının rolünü alır.
getRoles(users)Role[]Grup bağlamında kullanıcıların rollerini alır.
getUsers()User[]Grubun, bilinen bir karşılık gelen Google hesabına sahip doğrudan üyelerini alır.
hasGroup(group)BooleanBir grubun bu grubun doğrudan üyesi olup olmadığını test eder.
hasGroup(email)BooleanBir grubun bu grubun doğrudan üyesi olup olmadığını test eder.
hasUser(email)BooleanKullanıcının, grubun doğrudan üyesi olup olmadığını test eder.
hasUser(user)BooleanKullanıcının, grubun doğrudan üyesi olup olmadığını test eder.

Ayrıntılı belgeler

getEmail()

Bu grubun e-posta adresini alır.

Bu örnekte kullanıcının ait olduğu tüm grupların e-posta adresi listelenir.

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

Return

String: Grubun e-posta adresi.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getGroups()

Grubun doğrudan alt gruplarını alır. Grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Bu yönteme ek olarak, bir alanda grup üyelerini almak için Admin SDK Directory gelişmiş hizmetini de kullanabilirsiniz.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  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[]: Grubun doğrudan tüm alt grupları.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getRole(email)

Grup bağlamında kullanıcının rolünü alır. Bir grubun doğrudan üyesi olan bir kullanıcı, grup içinde tam olarak tek bir role sahiptir. Kullanıcı grubun üyesi değilse veya grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Bu örnekte bir grubun sahipleri listelenmektedir:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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());
  }
}

Parametreler

AdTürAçıklama
emailStringKullanıcının e-posta adresi.

Return

Role: İlgili kullanıcının gruptaki rolüdür.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getRole(user)

Grup bağlamında kullanıcının rolünü alır. Bir grubun doğrudan üyesi olan bir kullanıcı, grup içinde tam olarak tek bir role sahiptir. Kullanıcı grubun üyesi değilse veya grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Bu örnekte bir grubun sahipleri listelenmektedir:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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());
  }
}

Parametreler

AdTürAçıklama
userUserRolü alınacak kullanıcı.

Return

Role: İlgili kullanıcının gruptaki rolüdür.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Aşağıdaki kaynakları da incelemenizi öneririz:


getRoles(users)

Grup bağlamında kullanıcıların rollerini alır. Bir grubun doğrudan üyesi olan bir kullanıcı, grup içinde tam olarak tek bir role sahiptir. Herhangi bir kullanıcı grubun üyesi değilse veya grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Bu örnekte bir grubun sahipleri listelenmektedir:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
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());
  }
}

Parametreler

AdTürAçıklama
usersUser[]Rolleri istenen kullanıcılar.

Return

Role[]: Gruptaki bu kullanıcıların rolleri.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getUsers()

Grubun, bilinen bir karşılık gelen Google hesabına sahip doğrudan üyelerini alır. Grubun üye listesini veya üye e-postalarını görüntüleme izniniz yoksa bir istisna oluşturur.

Not: Kendisi başka bir A grubunun üyesi olan bir B grubunun üyesiyseniz A grubuna dolaylı olarak abone olursunuz. Bu gruba gönderilen iletilerin kopyalarını alıyor olsanız da, aslında üst grup A'ya abone değilsinizdir.

Bir grubun üyelerini gösteren bir örneği aşağıda bulabilirsiniz. Grubu çalıştırmadan önce, grubun e-posta adresini alanınızdaki bir e-posta adresiyle değiştirin.

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  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());
  }
}
Bu yönteme ek olarak, bir alandaki grup üyelerini almak için Admin SDK Directory gelişmiş hizmetini de kullanabilirsiniz.

Return

User[]: Grubun doğrudan tüm üyeleri.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

hasGroup(group)

Bir grubun bu grubun doğrudan üyesi olup olmadığını test eder. Test edilen grup, bu grubun bir alt düzeyinde iç içe yerleştirilmişse yöntem true değerini döndürmez. Grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parametreler

AdTürAçıklama
groupGroupÜyeliğini test edilecek grup.

Return

Boolean — Söz konusu grup, bu grubun alt grubuysa true; aksi halde false.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

hasGroup(email)

Bir grubun bu grubun doğrudan üyesi olup olmadığını test eder. Test edilen grup, bu grubun bir alt düzeyinde iç içe yerleştirilmişse yöntem true değerini döndürmez. Grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

Parametreler

AdTürAçıklama
emailStringBir grubun e-posta adresi.

Return

Boolean — Söz konusu grup, bu grubun alt grubuysa true; aksi halde false.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

hasUser(email)

Kullanıcının, grubun doğrudan üyesi olup olmadığını test eder. Grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Geçerli kullanıcının bir grubun üyesi olup olmadığını kontrol eden bir örneği aşağıda bulabilirsiniz:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

Parametreler

AdTürAçıklama
emailStringKullanıcının e-posta adresi.

Return

Boolean — İlgili kullanıcı grubun üyesiyse true; aksi halde false.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

hasUser(user)

Kullanıcının, grubun doğrudan üyesi olup olmadığını test eder. Grubun üye listesini görüntüleme izniniz yoksa bir istisna oluşturur.

Geçerli kullanıcının bir grubun üyesi olup olmadığını kontrol eden bir örneği aşağıda bulabilirsiniz:

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

Parametreler

AdTürAçıklama
userUserÜyeliği test edilecek kullanıcı.

Return

Boolean — İlgili kullanıcı grubun üyesiyse true; aksi halde false.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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