此页面由 Cloud Translation API 翻译。

Groups Service

此服务允许脚本访问 Google 群组。它可用于查询群组的电子邮件地址或用户是直接成员的群组列表等信息。以下示例展示了当前用户是多少个群组的成员：

var groups = GroupsApp.getGroups();
Logger.log('You are a member of %s Google Groups.', groups.length);

类

名称	简介
`Group`	一个群组对象，您可以查询其成员以及这些成员在群组中的角色。
`GroupsApp`	此类提供对 Google 群组信息的访问权限。
`Role`	用户在群组中的可能角色，例如所有者或普通成员。

方法	返回类型	简介
`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`	测试用户是否为群组的直接成员。

属性	类型	说明
`Role`	`Role`

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

属性	类型	说明
`OWNER`	`Enum`	群组的所有者。
`MANAGER`	`Enum`	群组的管理员。
`MEMBER`	`Enum`	此群组的成员，但既不是所有者也不是管理员。
`INVITED`	`Enum`	群组所有者或管理员邀请加入群组，但尚未接受邀请的用户。
`PENDING`	`Enum`	已请求加入群组，但尚未获得所有者或管理员批准的用户。
`BANNED`	`Enum`	被禁止加入某个群组的用户，无法尝试加入该群组。