Class GroupsApp

GroupsApp

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

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

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 – הקבוצה עם כתובת האימייל שצוינה.

אישור

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

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

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

חזרה

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

אישור

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

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