Class Group

组

一个群组对象，您可以查询其成员以及这些成员在群组中的角色。

以下示例展示了群组的成员。在运行该脚本之前，请将群组的电子邮件地址替换为您网域中的电子邮件地址。 

function listGroupMembers() {
  const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
  console.log(`${group.getEmail()}:`);
  const users = group.getUsers();
  for (let i = 0; i < users.length; i++) {
    const 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() {
  const groups = GroupsApp.getGroups();
  for (let i = 0; i < groups.length; i++) {
    console.log(groups[i].getEmail());
  }
}

返回

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

授权

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

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

getGroups()

检索群组的直接子群组。如果您无权查看群组的成员列表，则会抛出异常。

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

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

返回

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

授权

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

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

getRole(email)

检索用户在群组中的角色。作为群组的直接成员的用户在该群组中只有一个角色。如果用户不是群组成员，或者您无权查看群组的成员列表，则会抛出异常。

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const users = group.getUsers();
console.log('These are the group owners:');
for (let i = 0; i < users.length; i++) {
  const 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)

检索用户在群组中的角色。作为群组的直接成员的用户在该群组中只有一个角色。如果用户不是群组成员，或者您无权查看群组的成员列表，则会抛出异常。

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

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

参数

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

返回

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

授权

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

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

另请参阅

getRoles(users)

检索群组中用户的角色。作为群组的直接成员的用户在该群组中只有一个角色。如果任何用户都不是群组成员，或者您无权查看群组的成员列表，则会抛出异常。

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const users = group.getUsers();
const roles = group.getRoles(users);
console.log('These are the group owners:');
for (let 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() {
  const GROUP_EMAIL = 'example@googlegroups.com';
  const group = GroupsApp.getGroupByEmail(GROUP_EMAIL);
  const users = group.getUsers();
  console.log(`Group ${GROUP_EMAIL} has ${users.length} members:`);
  for (let i = 0; i < users.length; i++) {
    const user = users[i];
    console.log(user.getEmail());
  }
}
 除了此方法之外，您还可以使用 Admin SDK Directory 高级服务检索网域中的群组成员。

返回

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

授权

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

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

hasGroup(group)

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

const group = GroupsApp.getGroupByEmail('example@googlegroups.com');
const 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。如果您无权查看群组的成员列表，则会抛出异常。 

const 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)

测试用户是否为群组的直接成员。如果您无权查看群组的成员列表，则会抛出异常。

下面的示例会检查当前用户是否为某个群组的成员： 

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

测试用户是否为群组的直接成员。如果您无权查看群组的成员列表，则会抛出异常。

下面的示例会检查当前用户是否为某个群组的成员： 

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

参数

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

返回

Boolean - 如果相应用户是群组成员，则为 true；否则为 false。

授权

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

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