Class GroupsApp

GroupsApp

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

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

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

מאפיינים

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

Methods

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

תיעוד מפורט

getGroupByEmail(email)

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

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
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.');
}

פרמטרים

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

חזרה

‫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);
}
 שימו לב: אם אתם חברים בקבוצה ב', שהיא עצמה חברה בקבוצה א', אתם מנויים באופן עקיף לקבוצה א'. למרות שאתם מקבלים עותקים של הודעות שנשלחות לקבוצה 'הורה' A, אתם לא רשומים לקבוצה הזו.

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

חזרה

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

אישור

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

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