Class GroupsApp

GroupsApp

此类提供对 Google 网上论坛信息的访问权限。它可用于查询信息,例如群组的电子邮件地址或用户作为直接成员的群组列表。

以下示例显示了当前用户所属的群组:

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

属性

媒体资源类型说明
RoleRole

方法

方法返回类型简介
getGroupByEmail(email)Group检索具有指定电子邮件地址的群组。
getGroups()Group[]检索您是其直接成员(或待处理成员)的所有群组。

详细文档

getGroupByEmail(email)

检索具有指定电子邮件地址的群组。如果群组不存在或您无权查看,则会抛出异常。

以下示例根据电子邮件地址获取群组,并输出当前用户是否为成员。在运行之前,请将示例电子邮件地址替换为真实群组的电子邮件地址。

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

参数

名称类型说明
emailString要检索的群组的电子邮件地址。

弃踢回攻

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。即使您收到发送至“父级”群组 A 的消息副本,但您实际上并未订阅该群组。

您可以使用 Group.getRole(email) 确定您是返回群组的现有成员还是待处理成员。

弃踢回攻

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

授权

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

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