Class GroupsApp

GroupsApp

Этот класс предоставляет доступ к информации о группах Google. Его можно использовать для запроса такой информации, как адрес электронной почты группы или список групп, в которых пользователь является непосредственным участником.

Вот пример, показывающий, в скольких группах состоит текущий пользователь:

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