Class GroupsApp

GroupsApp

ชั้นเรียนนี้ให้สิทธิ์การเข้าถึงข้อมูล Google Groups ซึ่งใช้เพื่อค้นหาข้อมูล เช่น เป็นอีเมลของกลุ่ม หรือรายชื่อกลุ่มที่ผู้ใช้เป็นสมาชิกโดยตรง

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

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

พร็อพเพอร์ตี้

พร็อพเพอร์ตี้ประเภทคำอธิบาย
RoleRole

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getGroupByEmail(email)Groupเรียกข้อมูลกลุ่มที่มีอีเมลที่ระบุ
getGroups()Group[]ดึงข้อมูลกลุ่มทั้งหมดที่คุณเป็นสมาชิกโดยตรง (หรือสมาชิกที่รออนุมัติ)

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

getGroupByEmail(email)

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

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

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

พารามิเตอร์

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

รีเทิร์น

Group — กลุ่มที่มีอีเมลที่ระบุ

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

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

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

getGroups()

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

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

function showMyGroups() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}
โปรดทราบว่าหากคุณเป็นสมาชิกของกลุ่ม B ซึ่งเป็นสมาชิกของกลุ่มอื่น A คุณได้สมัครสมาชิกกลุ่ม A โดยอ้อม แม้ว่าคุณจะได้รับสำเนาข้อความ ส่งไปยัง "ผู้ปกครอง" กลุ่ม A คุณไม่ได้สมัครสมาชิกกลุ่มนั้น

คุณสามารถใช้ Group.getRole(email) เพื่อระบุว่าคุณอยู่ในสถานะเดิมหรือรอดำเนินการได้ สมาชิกของกลุ่มที่แสดงผล

รีเทิร์น

Group[] — รายชื่อกลุ่มที่ผู้ใช้เป็นสมาชิกโดยตรง

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

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

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