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());
  }
}

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
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()

يستردّ المجموعات الفرعية المباشرة للمجموعة. يُلقي استثناءً إذا لم يكن لديك إذن بالاطّلاع على قائمة أعضاء المجموعة.

بالإضافة إلى هذه الطريقة، يمكنك استخدام الخدمة المتقدّمة دليل SDK للمشرف ل retrieving members of a group in a domain.

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 معروف ومرتبط يُلقي ملف تعريف الارتباط استثناءً إذا لم يكن لديك إذن بالاطّلاع على قائمة أعضاء المجموعة أو عناوين بريدهم الإلكتروني.

ملاحظة: إذا كنت عضوًا في مجموعة "ب" التي هي نفسها عضو في مجموعة "أ" أخرى، فأنت مشترك بشكل غير مباشر في المجموعة "أ". على الرغم من أنّك تتلقّى نُسخًا من الرسائل المُرسَلة إلى هذه المجموعة، إلا أنّك لست مشتركًا في المجموعة الرئيسية "أ".

في ما يلي مثال يعرض أعضاء مجموعة. قبل تشغيله، استبدِل عنوان البريد الإلكتروني للمجموعة بعنوان بريد إلكتروني على نطاقك.

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());
  }
}

بالإضافة إلى هذه الطريقة، يمكنك استخدام الخدمة المتقدّمة دليل "SDK للمشرف" ل retrieving retrieve members of a group in a domain.

الإرجاع

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 إذا كان هذا المستخدم عضوًا في المجموعة، false في حال عدم انضمامه إليها

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

• 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 إذا كان هذا المستخدم عضوًا في المجموعة، false في حال عدم انضمامه إليها

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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