Class GroupsApp

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 的成员，而群组 B 本身也属于另一个群组 A，那么 您间接订阅了 A 组。即使您收到了邮件的副本 发送到“父级”则您实际上并未订阅该论坛

您可以使用 Group.getRole(email) 来确定您是现有账号还是待审批账号 是返回的群组的成员。

返回

Group[] - 用户直接成员的群组列表。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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