דף זה תורגם על ידי Cloud Translation API.

Class Group

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

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

function listGroupMembers() {
  var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
  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 = "example@googlegroups.com";
  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("example@googlegroups.com");
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("example@googlegroups.com");
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("example@googlegroups.com");
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 = "example@googlegroups.com";
  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("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

פרמטרים

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

החזרות

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

הרשאות

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

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

`hasGroup(email)`

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

פרמטרים

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

החזרות

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

הרשאות

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

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

`hasUser(email)`

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

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

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