หน้านี้ได้รับการแปลโดย Cloud Translation API

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[] — กลุ่มย่อยโดยตรงทั้งหมดของกลุ่ม

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

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

`getRole(email)`

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

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`email`	`String`	อีเมลของผู้ใช้

รีเทิร์น

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

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

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

`getRole(user)`

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`user`	`User`	ผู้ใช้ที่มีบทบาทที่จะเรียกดู

รีเทิร์น

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

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

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

ดูเพิ่มเติม

getRole(email)

`getRoles(users)`

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

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`users`	`User[]`	ผู้ใช้ที่มีคำขอบทบาท

รีเทิร์น

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

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

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 Directory เพื่อเรียกดูสมาชิกกลุ่มในโดเมนได้

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`hasGroup(email)`

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`email`	`String`	อีเมลของกลุ่ม

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`email`	`String`	อีเมลของผู้ใช้

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`user`	`User`	ผู้ใช้ที่เป็นเจ้าของการเป็นสมาชิกที่จะทดสอบ

รีเทิร์น

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

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

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