Class GroupsApp

ГруппыПриложение

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

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

var groups = GroupsApp.getGroups();
Logger.log('You belong to ' + groups.length + ' groups.');

Характеристики

Свойство	Тип	Описание
Role	Role

Методы

Метод	Тип возврата	Краткое описание
getGroupByEmail(email)	Group	Получает группу, имеющую указанный адрес электронной почты.
getGroups()	Group[]	Возвращает все группы, в которых вы являетесь прямым участником (или ожидаемым участником).

Подробная документация

getGroupByEmail(email)

Получает группу, имеющую указанный адрес электронной почты. Выдает исключение, если группа не существует или у вас нет разрешения на ее просмотр.

Вот пример, который получает группу по ее адресу электронной почты и выводит информацию о том, является ли текущий пользователь ее участником. Перед запуском замените образец адреса электронной почты реальным адресом электронной почты группы.

var group = GroupsApp.getGroupByEmail("[e-mail]");
var 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() {
  var groups = GroupsApp.getGroups();
  var str = 'You are in ' + groups.length + ' groups: ';
  for (var i = 0; i < groups.length; i++) {
    var group = groups[i];
    str = str + group.getEmail() + ' ';
  }
  Logger.log(str);
}

Обратите внимание: если вы являетесь членом группы B, которая сама является членом другой группы A, то вы косвенно подписаны на группу A. Даже если вы получаете копии сообщений, отправленных в «родительскую» группу А, на самом деле вы не подписаны на эту группу.

Вы можете использовать Group.getRole(email) , чтобы определить, являетесь ли вы существующим или ожидающим членом возвращаемых групп.

Возвращаться

Group[] — Список групп, непосредственным членом которых является пользователь.

Авторизация

Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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