REST Resource: groups

资源：群组

Google 群组可让您的用户使用群组的电子邮件地址向一群人发送邮件。如需详细了解常见任务，请参阅开发者指南。

如需了解其他类型的群组，请参阅 Cloud Identity Groups API 文档。

注意：调用此 API 的用户（或被服务账号模拟的用户）必须拥有包含 Admin API 群组权限的已分配角色，例如超级用户或群组管理员。

JSON 表示法 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
字段
id

string

只读。群组的唯一 ID。群组 id 可用作群组请求 URI 的 groupKey。
email

string

群组的电子邮件地址。如果您的账号有多个域名，请为电子邮件地址选择合适的域名。email 必须是唯一的。创建组时必须提供此属性。群组电子邮件地址与用户名需遵守相同的字符使用规则，详情请参阅帮助中心。
name

string

群组的显示名称。
description

string

用于帮助用户确定群组用途的扩展说明。例如，您可以添加以下信息：谁应加入该群组、要发送给该群组的邮件类型、关于该群组的常见问题解答的链接或相关群组。长度上限为 4,096 个字符。
adminCreated

boolean

只读。如果此群组由管理员（而非用户）创建，则值为 true。
directMembersCount

string (int64 format)

直接成为该群组的成员的用户数量。如果某个群组是此群组（上级群组）的成员（下级群组），则下级群组的成员不会计入上级群组的 directMembersCount 属性。
kind

string

API 资源的类型。对于群组资源，值为 admin#directory#group。
etag

string

资源的 ETag。
aliases[]

string

只读。群组的别名电子邮件地址列表。如需添加、更新或移除群组的别名，请使用 groups.aliases 方法。如果在群组的 POST 或 PUT 请求中进行修改，则该修改会被忽略。
nonEditableAliases[]

string

只读。账号主域名或子域名以外的群组别名电子邮件地址列表，该列表无法修改。这些是群组使用的有效电子邮件地址。这是在群组的 API 响应中返回的只读属性。如果在群组的 POST 或 PUT 请求中进行修改，则该修改会被忽略。

方法

delete

 删除群组。

get

 检索组的属性。

insert

 创建群组。

list

 检索给定 userKey 的域或用户的所有群组（已分页）。

patch

 更新组的属性。

update

 更新组的属性。