Class Group

群组

其成员及其成员的群组对象群组中的各个角色

以下示例显示了群组的成员。运行之前，请先替换 该群组的地址与您网域上某个群组的地址相同。 

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

方法

方法返回类型简介
getEmail()String获取此群组的电子邮件地址。
getGroups()Group[]检索该组的直接子组。
getRole(email)Role检索用户在群组上下文中的角色。
getRole(user)Role检索用户在群组上下文中的角色。
getRoles(users)Role[]检索用户的群组环境中的角色。
getUsers()User[]获取群组中拥有已知相应 Google 账号的直接成员。
hasGroup(group)Boolean测试某个群组是否为此群组的直接成员。
hasGroup(email)Boolean测试某个群组是否为此群组的直接成员。
hasUser(email)Boolean测试用户是否是群组的直接成员。
hasUser(user)Boolean测试用户是否是群组的直接成员。

详细文档

getEmail()

获取此群组的电子邮件地址。

下例列出了用户所属的所有群组的电子邮件地址。 

function listMyGroupEmails() {
  var groups = GroupsApp.getGroups();
  for (var i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

返回

String - 群组的电子邮件地址。

授权

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

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

getGroups()

检索该组的直接子组。如果没有，则会引发异常 查看群组成员列表的权限。

除此方法外，您还可以使用 Admin SDK Directory 高级服务 检索域中的群组成员。 

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var childGroups = group.getGroups();
  console.log("Group " + GROUP_EMAIL + " has " + childGroups.length + " groups:");
  for (var i = 0; i < childGroups.length; i++) {
    var childGroup = childGroups[i];
    console.log(childGroup.getEmail());
  }
}

返回

Group[] - 群组的所有直接下级群组。

授权

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

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

getRole(email)

检索用户在群组上下文中的角色。是群组的直接成员的用户 在该群组中只有一个角色。如果用户不是 群组，或者您没有查看该群组的成员列表的权限。

以下示例列出了群组的所有者： 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user.getEmail()) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

参数

名称类型说明
emailString用户的电子邮件地址。

返回

Role - 用户在群组中的角色。

授权

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

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

getRole(user)

检索用户在群组上下文中的角色。是群组的直接成员的用户 在该群组中只有一个角色。如果用户不是 群组，或者您没有查看该群组的成员列表的权限。

以下示例列出了群组的所有者： 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  var user = users[i];
  if (group.getRole(user) == GroupsApp.Role.OWNER) {
    console.log(user.getEmail());
  }
}

参数

名称类型说明
userUser要检索其角色的用户。

返回

Role - 用户在群组中的角色。

授权

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

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

另请参阅

getRoles(users)

检索用户的群组环境中的角色。是群组的直接成员的用户 在该群组中只有一个角色。如果有任何用户不是 群组，或者您没有查看该群组的成员列表的权限。

以下示例列出了群组的所有者： 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var users = group.getUsers();
var roles = group.getRoles(users);
console.log('These are the group owners:');
for (var i = 0; i < users.length; i++) {
  if (roles[i] == GroupsApp.Role.OWNER) {
    console.log(users[i].getEmail());
  }
}

参数

名称类型说明
usersUser[]请求其角色的用户。

返回

Role[] - 这些用户在群组中的角色。

授权

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

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

getUsers()

获取群组中拥有已知相应 Google 账号的直接成员。抛出 则可以例外。

注意：如果您是某个群组 B 的成员，而该群组 B 本身也属于另一个群组 A，那么您 间接订阅了群组 A。虽然您会收到发送到 则表示您实际上并未订阅父群组 A。

以下示例显示了群组的成员。运行之前，请先替换 该群组的地址与您网域上某个群组的地址相同。 

function listGroupMembers() {
  var GROUP_EMAIL = "example@googlegroups.com";
  var group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  var users = group.getUsers();
  console.log("Group " + GROUP_EMAIL + " has " + users.length + " members:");
  for (var i = 0; i < users.length; i++) {
    var user = users[i];
    console.log(user.getEmail());
  }
}
 除此方法外，您还可以使用 Admin SDK Directory 高级服务 检索域中的群组成员。

返回

User[] - 群组的所有直接成员。

授权

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

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

hasGroup(group)

测试某个群组是否为此群组的直接成员。如果存在以下情况，此方法不会返回 true： 被测试组嵌套在该组下多个级别。否则会抛出异常 无权查看群组的成员列表。 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var childGroup = GroupsApp.getGroupByEmail("childgroup@googlegroups.com");
if (group.hasGroup(childGroup)) {
  console.log("childgroup@googlegroups.com is a child group");
}

参数

名称类型说明
groupGroup要测试其成员资格的群组。

返回

Boolean - 如果该组是该组的子组，则为 true；否则为 false。

授权

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

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

hasGroup(email)

测试某个群组是否为此群组的直接成员。如果存在以下情况，此方法不会返回 true： 被测试组嵌套在该组下多个级别。否则会抛出异常 无权查看群组的成员列表。 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
if (group.hasGroup("childgroup@googlegroups.com")) {
  console.log("childgroup@googlegroups.com is a child group");
}

参数

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

返回

Boolean - 如果该组是该组的子组，则为 true；否则为 false。

授权

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

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

hasUser(email)

测试用户是否是群组的直接成员。如果没有，则会引发异常 查看群组成员列表的权限。

以下示例检查当前用户是否为群组的成员： 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser.getEmail())) {
  console.log("You are a member");
}

参数

名称类型说明
emailString用户的电子邮件地址。

返回

Boolean - true（如果该用户是群组的成员）；否则为 false。

授权

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

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

hasUser(user)

测试用户是否是群组的直接成员。如果没有，则会引发异常 查看群组成员列表的权限。

以下示例检查当前用户是否为群组的成员： 

var group = GroupsApp.getGroupByEmail("example@googlegroups.com");
var currentUser = Session.getActiveUser();
if (group.hasUser(currentUser)) {
  console.log("You are a member");
}

参数

名称类型说明
userUser要测试其成员资格的用户。

返回

Boolean - true（如果该用户是群组的成员）；否则为 false。

授权

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

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