Class GroupsApp

گروه‌ها

این کلاس دسترسی به اطلاعات گروه‌های گوگل را فراهم می‌کند. می‌توان از آن برای پرس‌وجوی اطلاعاتی مانند آدرس ایمیل یک گروه یا فهرست گروه‌هایی که کاربر مستقیماً عضو آنهاست، استفاده کرد.

در اینجا مثالی آورده شده است که نشان می‌دهد کاربر فعلی عضو چند گروه است:

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

خواص

ملک نوع توضیحات
Role Role

روش‌ها

روش نوع بازگشتی شرح مختصر
get Group By Email(email) Group گروهی را که آدرس ایمیل مشخص شده را دارد، بازیابی می‌کند.
get Groups() 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.');
}

پارامترها

نام نوع توضیحات
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);
}
توجه داشته باشید که اگر شما عضو گروهی به نام B هستید که خود عضو گروه دیگری به نام A است، در این صورت به طور غیرمستقیم در گروه A مشترک شده‌اید. اگرچه کپی‌هایی از پیام‌های ارسال شده به گروه "والد" A را دریافت می‌کنید، اما در واقع در آن گروه مشترک نشده‌اید.

می‌توانید از Group.getRole(email) برای تعیین اینکه آیا عضو فعلی یا در انتظار عضویت در گروه‌های برگردانده شده هستید، استفاده کنید.

بازگشت

Group[] — فهرست گروه‌هایی که کاربر مستقیماً عضو آنهاست.

مجوز

اسکریپت‌هایی که از این روش استفاده می‌کنند، نیاز به مجوز با یک یا چند مورد از حوزه‌های زیر دارند:

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