Class Group

קבוצה

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

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

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('[e-mail]');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
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() {
  const groups = GroupsApp.getGroups();
  for (let i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

חזרה

‫String — כתובת האימייל של הקבוצה.

אישור

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

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

---

getGroups()

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

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

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const childGroups = group.getGroups();
  console.log(`Group ${GROUP_EMAIL} has ${childGroups.length} groups:`);
  for (let i = 0; i < childGroups.length; i++) {
    const childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

חזרה

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

אישור

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

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

---

getRole(email)

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

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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)

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

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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)

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

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let 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 תואם ידוע. אם אין לכם הרשאה לראות את רשימת חברי הקבוצה או את כתובות האימייל של החברים, תופעל חריגה.

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

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

function listGroupMembers() {
  const GROUP_EMAIL = '[e-mail]';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const users = group.getUsers();
  console.log(`Group ${GROUP_EMAIL} has ${users.length} members:`);
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

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

חזרה

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

אישור

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

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

---

hasGroup(group)

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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 אם הקבוצה שנבדקת מוטמעת ביותר מרמה אחת מתחת לקבוצה הזו. אם אין לכם הרשאה לראות את רשימת חברי הקבוצה, תופעל חריגה.

const 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)

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

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

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

פרמטרים

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

חזרה

Boolean — true if that user is a member of the group; false otherwise.

אישור

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

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

---

hasUser(user)

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

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

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

פרמטרים

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

חזרה

Boolean — true if that user is a member of the group; false otherwise.

אישור

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

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