Class Group

קבוצה

אובייקט קבוצה שהחברים בו ושל החברים האלה לחפש את התפקיד

הנה דוגמה שמציגה את חברי הקבוצה. לפני ההפעלה צריך להחליף את כתובת האימייל של הקבוצה עם הכתובת של הדומיין שלך.

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

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
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 – כתובת האימייל של הקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

getGroups()

אחזור של קבוצות הצאצא הישירות של הקבוצה. מחריג חריג אם אין לכם הרשאה לצפייה ברשימה של חברי הקבוצה.

בנוסף לשיטה הזו, אפשר להשתמש בשירות המתקדם Admin SDK Directory כדי לאחזר חברי קבוצה בדומיין.

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

חזרה

Group[] – כל קבוצות הצאצא הישירות של הקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

getRole(email)

אחזור תפקיד של משתמש בהקשר של הקבוצה. משתמש שהוא חבר ישיר בקבוצה יש להם תפקיד אחד בלבד בקבוצה הזו. משלם חריג אם המשתמש לא חבר קבוצה או שאין לך הרשאה לראות את רשימת חברי הקבוצה.

בדוגמה הבאה מפורטים הבעלים של הקבוצה:

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

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של המשתמש.

חזרה

Role – התפקיד של המשתמש בקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

getRole(user)

אחזור תפקיד של משתמש בהקשר של הקבוצה. משתמש שהוא חבר ישיר בקבוצה יש להם תפקיד אחד בלבד בקבוצה הזו. משלם חריג אם המשתמש לא חבר קבוצה או שאין לך הרשאה לראות את רשימת חברי הקבוצה.

בדוגמה הבאה מפורטים הבעלים של הקבוצה:

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

פרמטרים

שם	סוג	תיאור
user	User	המשתמש שאת התפקיד שלו צריך לאחזר.

חזרה

Role – התפקיד של המשתמש בקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

ראה גם

• getRole(email)

---

getRoles(users)

אחזור של משתמשים תפקידים בהקשר של הקבוצה. משתמש שהוא חבר ישיר בקבוצה יש להם תפקיד אחד בלבד בקבוצה הזו. פעולה זו גורמת לחריגה אם משתמש כלשהו אינו חבר קבוצה או שאין לך הרשאה לראות את רשימת חברי הקבוצה.

בדוגמה הבאה מפורטים הבעלים של הקבוצה:

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

פרמטרים

שם	סוג	תיאור
users	User[]	המשתמשים המבוקשים על התפקידים.

חזרה

Role[] – התפקידים של המשתמשים האלה בקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

getUsers()

מקבל את החברים הישירים בקבוצה שיש להם חשבון Google תואם ידוע. זורק אין לכם הרשאה לראות את רשימת חברי הקבוצה או את כתובות האימייל שלהם, במיוחד אם אין לכם הרשאה לראות את רשימת חברי הקבוצה.

הערה: אם אתם חברים בקבוצה ב' שהיא בעצמה חברה בקבוצה אחרת, אתם רשומים בצורה עקיפה לקבוצה א'. למרות שאתה מקבל עותקים של הודעות שנשלחו אל הוא בעצם לא רשום לקבוצת ההורה א'.

הנה דוגמה שמציגה את חברי הקבוצה. לפני ההפעלה צריך להחליף את כתובת האימייל של הקבוצה עם הכתובת של הדומיין שלך.

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

בנוסף לשיטה הזו, אפשר להשתמש בשירות המתקדם Admin SDK Directory כדי לאחזר חברי קבוצה בדומיין.

חזרה

User[] – כל החברים הישירים בקבוצה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

hasGroup(group)

הפונקציה בודקת אם קבוצה היא חברה ישירה בקבוצה. השיטה לא מחזירה את הערך true אם הקבוצה שנבדקה נמצאת בתוך יותר מרמה אחת מתחת לקבוצה הזו. הפעולה הזו גורמת לחריגה אם עושים את זה אין הרשאה להציג את רשימת חברי הקבוצה.

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

פרמטרים

שם	סוג	תיאור
group	Group	הקבוצה שהחברות שלה לבדיקה.

חזרה

Boolean – true אם הקבוצה היא קבוצת צאצא של הקבוצה הזו; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

hasGroup(email)

הפונקציה בודקת אם קבוצה היא חברה ישירה בקבוצה. השיטה לא מחזירה את הערך true אם הקבוצה שנבדקה נמצאת בתוך יותר מרמה אחת מתחת לקבוצה הזו. הפעולה הזו גורמת לחריגה אם עושים את זה אין הרשאה להציג את רשימת חברי הקבוצה.

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

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של הקבוצה.

חזרה

Boolean – true אם הקבוצה היא קבוצת צאצא של הקבוצה הזו; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

hasUser(email)

הפונקציה בודקת אם משתמש הוא חבר ישיר בקבוצה. מחריג חריג אם אין לכם הרשאה לצפייה ברשימה של חברי הקבוצה.

לפניכם דוגמה שבודקת אם המשתמש הנוכחי הוא חבר בקבוצה:

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

פרמטרים

שם	סוג	תיאור
email	String	כתובת האימייל של המשתמש.

חזרה

Boolean – true אם המשתמש הזה חבר בקבוצה; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

---

hasUser(user)

הפונקציה בודקת אם משתמש הוא חבר ישיר בקבוצה. מחריג חריג אם אין לכם הרשאה לצפייה ברשימה של חברי הקבוצה.

לפניכם דוגמה שבודקת אם המשתמש הנוכחי הוא חבר בקבוצה:

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

פרמטרים

שם	סוג	תיאור
user	User	המשתמש שהחברות שלו לבדיקה.

חזרה

Boolean – true אם המשתמש הזה חבר בקבוצה; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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