Class Group

گروه

یک شی گروه که اعضای آن و نقش آن اعضا در گروه قابل پرس و جو هستند.

در اینجا یک مثال است که اعضای یک گروه را نشان می دهد. قبل از اجرای آن، آدرس ایمیل گروه را با آدرس ایمیل دامنه خود جایگزین کنید.

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}

روش ها

روش نوع برگشت شرح مختصر
get Email() String آدرس ایمیل این گروه را دریافت می کند.
get Groups() Group[] گروه های فرزند مستقیم گروه را بازیابی می کند.
get Role(email) Role نقش کاربر را در زمینه گروه بازیابی می کند.
get Role(user) Role نقش کاربر را در زمینه گروه بازیابی می کند.
get Roles(users) Role[] نقش های کاربران را در زمینه گروه بازیابی می کند.
get Users() User[] اعضای مستقیم و اعضای ممنوعه گروه را که دارای یک حساب Google مربوطه شناخته شده هستند را دریافت می کند.
has Group(group) Boolean آزمایش می کند که آیا یک گروه عضو مستقیم این گروه است یا خیر.
has Group(email) Boolean آزمایش می کند که آیا یک گروه عضو مستقیم این گروه است یا خیر.
has User(email) Boolean آزمایش می کند که آیا کاربر عضو مستقیم گروه است یا خیر.
has User(user) Boolean آزمایش می کند که آیا کاربر عضو مستقیم گروه است یا خیر.

مستندات دقیق

get Email()

آدرس ایمیل این گروه را دریافت می کند.

این مثال آدرس ایمیل تمام گروه هایی را که کاربر به آنها تعلق دارد فهرست می کند.

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

get Groups()

گروه های فرزند مستقیم گروه را بازیابی می کند. در صورتی که مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا می گذارد.

علاوه بر این روش، می توانید از سرویس پیشرفته Admin SDK Directory برای بازیابی اعضای گروه در یک دامنه استفاده کنید.

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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

get Role(email)

نقش کاربر را در زمینه گروه بازیابی می کند. کاربری که عضو مستقیم یک گروه است دقیقاً یک نقش در آن گروه دارد. در صورتی که کاربر عضو گروه نباشد یا اگر مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا ایجاد می کند.

این مثال صاحبان یک گروه را فهرست می کند:

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

get Role(user)

نقش کاربر را در زمینه گروه بازیابی می کند. کاربری که عضو مستقیم یک گروه است دقیقاً یک نقش در آن گروه دارد. در صورتی که کاربر عضو گروه نباشد یا اگر مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا ایجاد می کند.

این مثال صاحبان یک گروه را فهرست می کند:

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

همچنین ببینید

get Roles(users)

نقش های کاربران را در زمینه گروه بازیابی می کند. کاربری که عضو مستقیم یک گروه است دقیقاً یک نقش در آن گروه دارد. در صورتی که کاربر عضو گروه نباشد یا شما اجازه مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا ایجاد می کند.

این مثال صاحبان یک گروه را فهرست می کند:

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

get Users()

اعضای مستقیم و اعضای ممنوعه گروه را که دارای یک حساب Google مربوطه شناخته شده هستند را دریافت می کند. اگر مجوز مشاهده لیست اعضای گروه یا ایمیل های اعضا را نداشته باشید، یک استثنا ایجاد می کند.

توجه: اگر عضو گروه B هستید که خود عضو گروه A دیگری است، به طور غیرمستقیم مشترک گروه A هستید. اگرچه کپی هایی از پیام های ارسال شده به آن را دریافت می کنید، اما در واقع در گروه والد A مشترک نیستید.

در اینجا یک مثال است که اعضای یک گروه را نشان می دهد. قبل از اجرای آن، آدرس ایمیل گروه را با آدرس ایمیل دامنه خود جایگزین کنید.

function listGroupMembers() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  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());
  }
}
علاوه بر این روش، می توانید از سرویس پیشرفته Admin SDK Directory برای بازیابی اعضای گروه در یک دامنه استفاده کنید.

بازگشت

User[] - همه اعضای مستقیم گروه.

مجوز

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

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

has Group(group)

آزمایش می کند که آیا یک گروه عضو مستقیم این گروه است یا خیر. اگر گروه آزمایش شده بیش از یک سطح زیر این گروه تودرتو باشد، روش true برنمی گردد. در صورتی که مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا می گذارد.

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

has Group(email)

آزمایش می کند که آیا یک گروه عضو مستقیم این گروه است یا خیر. اگر گروه آزمایش شده بیش از یک سطح زیر این گروه تودرتو باشد، روش true برنمی گردد. در صورتی که مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا می گذارد.

const 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

has User(email)

آزمایش می کند که آیا کاربر عضو مستقیم گروه است یا خیر. در صورتی که مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا می گذارد.

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

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

has User(user)

آزمایش می کند که آیا کاربر عضو مستقیم گروه است یا خیر. در صورتی که مجوز مشاهده لیست اعضای گروه را نداشته باشید، یک استثنا می گذارد.

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

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