Class GroupsApp

אפליקציית קבוצות Google

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

דוגמה שבה מוצג מספר הקבוצות שהמשתמש הנוכחי חבר בהן:

const groups = GroupsApp.getGroups();
Logger.log(`You belong to ${groups.length} groups.`);

מאפיינים

נכס	סוג	תיאור
Role	Role

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
getGroupByEmail(email)	Group	אחזור הקבוצה עם כתובת האימייל שצוינה.
getGroups()	Group[]	אחזור של כל הקבוצות שאתם חברים בהן ישירות (או שהבקשה שלכם להצטרף אליהן נמצאת בהמתנה).

מסמכים מפורטים

getGroupByEmail(email)

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

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

const group = GroupsApp.getGroupByEmail('[e-mail]');
const 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.');
}

פרמטרים

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

חזרה

Group – הקבוצה עם כתובת האימייל שצוינה.

אישור

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

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

---

getGroups()

אחזור של כל הקבוצות שאתם חברים בהן ישירות (או שהבקשה שלכם להצטרף אליהן נמצאת בהמתנה). אם אתם לא חברים בקבוצות, הרשימה הזו תהיה ריקה. גורמת להשלכת חריגה אם הקבוצה לא קיימת או שאין לכם הרשאה לראות אותה.

דוגמה להדפסת כתובת האימייל של כל קבוצה שהמשתמש שייך אליה:

function showMyGroups() {
  const groups = GroupsApp.getGroups();
  let str = `You are in ${groups.length} groups: `;
  for (let i = 0; i < groups.length; i++) {
    const group = groups[i];
    str = `${str + group.getEmail()} `;
  }
  Logger.log(str);
}

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

אפשר להשתמש ב-Group.getRole(email) כדי לקבוע אם אתם חברים קיימים בקבוצות שהוחזרו או אם אתם מחכים להצטרפות.

חזרה

Group[] – רשימת הקבוצות שהמשתמש הוא חבר ישיר בהן.

אישור

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

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