REST Resource: members

资源:成员

Google 群组成员可以是用户,也可以是其他群组。此成员可以是在您账号的网域内部或外部。要详细了解群组成员的常见任务,请参阅开发者指南

JSON 表示法
{
  "kind": string,
  "email": string,
  "role": string,
  "etag": string,
  "type": string,
  "status": string,
  "delivery_settings": string,
  "id": string
}
字段
kind

string

API 资源的类型。对于成员资源,值为 admin#directory#member

email

string

成员的电子邮件地址。成员可以是用户,也可以是其他群组。在向群组添加成员时,此属性是必需的。email必须是唯一的,并且不能是其他群组的别名。如果电子邮件地址发生更改,API 会自动反映电子邮件地址的更改。

role

string

成员在群组中的角色。对于群组成员资格中的周期,API 会返回错误。例如,如果 group1group2 的成员,则 group2 不能是 group1 的成员。要详细了解成员角色,请参阅为成员分配群组角色

可接受的值为:

  • MANAGER:只有在通过管理控制台启用 Google 网上论坛企业版时才可使用此角色。请参阅启用或停用网上论坛企业版MANAGER 角色可以执行 OWNER 角色的所有操作,但不能将成员设为 OWNER 或删除群组。一个群组可以有多个 MANAGER 成员。
  • MEMBER:此角色可以订阅群组、查看讨论归档以及查看群组的成员资格列表。要详细了解成员角色,请参阅为成员分配群组角色
  • OWNER:此角色可以向群组发送邮件、添加或移除成员、更改成员角色、更改群组设置以及删除群组。OWNER 必须是该群组的成员。一个群组可以有多个 OWNER
etag

string

资源的 ETag。

type

string

群组成员的类型。

可接受的值为:

  • CUSTOMER:成员表示网域中的所有用户。系统不会返回电子邮件地址,返回的 ID 就是客户 ID。
  • EXTERNAL:成员是网域外的用户或群组。(目前未使用)
  • GROUP:该成员是其他群组。
  • USER:成员是用户。
status

string

成员状态(不可变)

delivery_settings

string

定义成员的邮件递送偏好设置。只有 insertupdateget 方法支持此字段。

可接受的值为:

  • ALL_MAIL:所有邮件在送达后立即递送。
  • DAILY:每天不超过一条消息。
  • DIGEST:最多 25 条消息,汇总到一条消息中。
  • DISABLED:移除订阅。
  • NONE:没有消息。
id

string

群组成员的唯一 ID。成员 id 可用作成员请求 URI 的 memberKey

方法

delete

从群组中移除成员。

get

检索群组成员的属性。

hasMember

检查指定用户是否为群组成员。

insert

向指定的群组添加用户。

list

检索群组中所有成员的分页列表。

patch

更新指定群组中用户的成员资格属性。

update

更新指定群组中用户的成员资格。