Class Group

กลุ่ม

ออบเจ็กต์กลุ่มซึ่งมีสมาชิกและสมาชิกเหล่านั้น ภายในกลุ่มได้

นี่คือตัวอย่างที่แสดงสมาชิกของกลุ่ม ก่อนที่จะเรียกใช้ โปรดแทนที่อีเมล ของกลุ่มโดยใช้ที่อยู่ในโดเมนของคุณ 

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());
  }
}

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getEmail()Stringรับอีเมลของกลุ่มนี้
getGroups()Group[]เรียกข้อมูลกลุ่มย่อยโดยตรงของกลุ่ม
getRole(email)Roleเรียกข้อมูลบทบาทของผู้ใช้ในบริบทของกลุ่ม
getRole(user)Roleเรียกข้อมูลบทบาทของผู้ใช้ในบริบทของกลุ่ม
getRoles(users)Role[]เรียกข้อมูลผู้ใช้ บทบาทในบริบทของกลุ่ม
getUsers()User[]รับสมาชิกโดยตรงของกลุ่มที่มีบัญชี Google ที่เกี่ยวข้องซึ่งเป็นที่รู้จัก
hasGroup(group)Booleanทดสอบว่ากลุ่มใดเป็นสมาชิกโดยตรงของกลุ่มนี้
hasGroup(email)Booleanทดสอบว่ากลุ่มใดเป็นสมาชิกโดยตรงของกลุ่มนี้
hasUser(email)Booleanทดสอบว่าผู้ใช้เป็นสมาชิกโดยตรงของกลุ่มหรือไม่
hasUser(user)Booleanทดสอบว่าผู้ใช้เป็นสมาชิกโดยตรงของกลุ่มหรือไม่

เอกสารโดยละเอียด

getEmail()

รับอีเมลของกลุ่มนี้

ตัวอย่างนี้แสดงที่อยู่อีเมลของกลุ่มทั้งหมดที่ผู้ใช้เป็นสมาชิก 

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

รีเทิร์น

String — อีเมลของกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getGroups()

เรียกข้อมูลกลุ่มย่อยโดยตรงของกลุ่ม จะมีข้อยกเว้นหากคุณไม่มี สิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

นอกเหนือจากวิธีการนี้ คุณสามารถใช้บริการขั้นสูงไดเรกทอรี Admin SDK เพื่อทำสิ่งต่อไปนี้ได้ เรียกสมาชิกกลุ่มในโดเมน 

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());
  }
}

รีเทิร์น

Group[] — กลุ่มย่อยโดยตรงทั้งหมดของกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRole(email)

เรียกข้อมูลบทบาทของผู้ใช้ในบริบทของกลุ่ม ผู้ใช้ที่เป็นสมาชิกโดยตรงของกลุ่ม มีบทบาทภายในกลุ่มนั้นเพียง 1 บทบาทเท่านั้น มีข้อยกเว้นหากผู้ใช้ไม่ได้เป็นสมาชิกของ หรือคุณไม่มีสิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

ตัวอย่างนี้แสดงเจ้าของกลุ่ม 

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());
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailStringอีเมลของผู้ใช้

รีเทิร์น

Role — บทบาทของผู้ใช้นั้นภายในกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getRole(user)

เรียกข้อมูลบทบาทของผู้ใช้ในบริบทของกลุ่ม ผู้ใช้ที่เป็นสมาชิกโดยตรงของกลุ่ม มีบทบาทภายในกลุ่มนั้นเพียง 1 บทบาทเท่านั้น มีข้อยกเว้นหากผู้ใช้ไม่ได้เป็นสมาชิกของ หรือคุณไม่มีสิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

ตัวอย่างนี้แสดงเจ้าของกลุ่ม 

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());
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserผู้ใช้ที่มีบทบาทที่จะเรียกข้อมูล

รีเทิร์น

Role — บทบาทของผู้ใช้นั้นภายในกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ดูเพิ่มเติม

getRoles(users)

เรียกข้อมูลผู้ใช้ บทบาทในบริบทของกลุ่ม ผู้ใช้ที่เป็นสมาชิกโดยตรงของกลุ่ม มีบทบาทภายในกลุ่มนั้นเพียง 1 บทบาทเท่านั้น มีข้อยกเว้นหากผู้ใช้ไม่ได้เป็นสมาชิกของ หรือคุณไม่มีสิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

ตัวอย่างนี้แสดงเจ้าของกลุ่ม 

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());
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
usersUser[]ผู้ใช้ที่มีบทบาทที่ขอ

รีเทิร์น

Role[] — บทบาทของผู้ใช้ภายในกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getUsers()

รับสมาชิกโดยตรงของกลุ่มที่มีบัญชี Google ที่เกี่ยวข้องซึ่งเป็นที่รู้จัก ส่ง ในกรณีที่คุณไม่มีสิทธิ์ดูรายชื่อสมาชิกของกลุ่มหรืออีเมลของสมาชิก

หมายเหตุ: หากคุณเป็นสมาชิกของกลุ่ม B ซึ่งเป็นสมาชิกของกลุ่มอื่น A สมัครเป็นสมาชิกกลุ่ม A โดยอ้อม แม้ว่าคุณจะได้รับสำเนาของข้อความที่ส่งถึง คุณยังไม่ได้สมัครสมาชิกกลุ่มหลัก A

นี่คือตัวอย่างที่แสดงสมาชิกของกลุ่ม ก่อนที่จะเรียกใช้ โปรดแทนที่อีเมล ของกลุ่มโดยใช้ที่อยู่ในโดเมนของคุณ 

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());
  }
}
 นอกเหนือจากวิธีการนี้ คุณยังใช้บริการขั้นสูงไดเรกทอรี Admin SDK เพื่อทำสิ่งต่อไปนี้ได้ เรียกสมาชิกกลุ่มในโดเมน

รีเทิร์น

User[] — สมาชิกโดยตรงทั้งหมดของกลุ่ม

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hasGroup(group)

ทดสอบว่ากลุ่มใดเป็นสมาชิกโดยตรงของกลุ่มนี้ เมธอดจะไม่แสดงผล true หาก กลุ่มที่ทดสอบซ้อนอยู่ใต้กลุ่มนี้มากกว่า 1 ระดับ จะมีข้อยกเว้นหากคุณทำเช่นนั้น ไม่มีสิทธิ์ดูรายชื่อสมาชิกของกลุ่ม 

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");
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
groupGroupกลุ่มที่จะทดสอบการเป็นสมาชิก

รีเทิร์น

Boolean — true หากกลุ่มนั้นเป็นกลุ่มย่อยของกลุ่มนี้ false หรือไม่เช่นนั้น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hasGroup(email)

ทดสอบว่ากลุ่มใดเป็นสมาชิกโดยตรงของกลุ่มนี้ เมธอดจะไม่แสดงผล true หาก กลุ่มที่ทดสอบซ้อนอยู่ใต้กลุ่มนี้มากกว่า 1 ระดับ จะมีข้อยกเว้นหากคุณทำเช่นนั้น ไม่มีสิทธิ์ดูรายชื่อสมาชิกของกลุ่ม 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailStringอีเมลของกลุ่ม

รีเทิร์น

Boolean — true หากกลุ่มนั้นเป็นกลุ่มย่อยของกลุ่มนี้ false หรือไม่เช่นนั้น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hasUser(email)

ทดสอบว่าผู้ใช้เป็นสมาชิกโดยตรงของกลุ่มหรือไม่ จะมีข้อยกเว้นหากคุณไม่มี สิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

ต่อไปนี้เป็นตัวอย่างที่ตรวจสอบว่าผู้ใช้ปัจจุบันเป็นสมาชิกของกลุ่มหรือไม่ 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailStringอีเมลของผู้ใช้

รีเทิร์น

Boolean — true หากผู้ใช้นั้นเป็นสมาชิกของกลุ่ม false หรือไม่เช่นนั้น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

hasUser(user)

ทดสอบว่าผู้ใช้เป็นสมาชิกโดยตรงของกลุ่มหรือไม่ จะมีข้อยกเว้นหากคุณไม่มี สิทธิ์ในการดูรายชื่อสมาชิกของกลุ่ม

ต่อไปนี้เป็นตัวอย่างที่ตรวจสอบว่าผู้ใช้ปัจจุบันเป็นสมาชิกของกลุ่มหรือไม่ 

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserผู้ใช้ที่จะทดสอบการเป็นสมาชิก

รีเทิร์น

Boolean — true หากผู้ใช้นั้นเป็นสมาชิกของกลุ่ม false หรือไม่เช่นนั้น

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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