REST Resource: spaces.members

资源:Membership

表示 Google Chat 中的成员关系,例如用户或 Chat 应用是否受邀加入聊天室、是否是聊天室的成员或是否缺席聊天室。

JSON 表示法
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,

  // Union field memberType can be only one of the following:
  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
  // End of list of possible types for union field memberType.
}
字段
name

string

标识符。由服务器分配的会员资格的资源名称。

格式:spaces/{space}/members/{member}

state

enum (MembershipState)

仅限输出。会员资格的状态。

role

enum (MembershipRole)

可选。用户在 Chat 聊天室中的角色,决定了用户在聊天室中可以执行的操作。

此字段只能在 members.patch 中用作输入。

createTime

string (Timestamp format)

可选。不可变。成员资格的创建时间,例如成员加入聊天室或受邀加入聊天室的时间。此字段仅为输出字段,除非用于在导入模式聊天室中导入历史成员资格。

deleteTime

string (Timestamp format)

可选。不可变。成员资格的删除时间,例如成员退出或被从聊天室中移除的时间。此字段仅为输出字段,除非用于在导入模式聊天室中导入历史成员资格。

联合字段 memberType。与相应会员资格关联的会员。未来可能会支持其他会员类型。memberType 只能是下列其中一项:
member

object (User)

可选。相应成员资格对应的 Google Chat 用户或应用。如果您的 Chat 应用以用户身份进行身份验证,则输出会填充 user nametype

groupMember

object (Group)

可选。相应会员资格对应的 Google 群组。

读取或更改 Google 群组的成员资格需要进行用户身份验证

MembershipState

指定成员与空间的关系。未来可能会支持其他会员状态。

枚举
MEMBERSHIP_STATE_UNSPECIFIED 默认值。请勿使用。
JOINED 用户已添加到聊天室,可以参与聊天室中的对话。
INVITED 用户已受邀加入聊天室,但尚未加入。
NOT_A_MEMBER 相应用户不属于相应聊天室,也没有待处理的加入聊天室邀请。

MembershipRole

表示用户在 Chat 聊天室中的许可操作。未来可能会添加更多枚举值。

枚举
MEMBERSHIP_ROLE_UNSPECIFIED 默认值。对于 users:他们不是聊天室成员,但可以被邀请。对于 Google Groups:系统始终会为其分配此角色(未来可能会使用其他枚举值)。
ROLE_MEMBER

聊天室的成员。在聊天界面中,此角色称为“成员”。

用户拥有基本权限,例如向聊天室发送消息。管理员和所有者可以向聊天室中的成员授予其他权限,包括:

  • 添加或移除成员。
  • 修改聊天室详细信息。
  • 开启或关闭聊天记录。
  • 使用 @all 提及聊天室中的所有人。
  • 管理聊天室中安装的 Chat 应用和 webhook。

在私信和未命名的群组对话中,所有人都具有此角色。

ROLE_MANAGER

聊天室所有者。在聊天界面中,此角色称为“所有者”。

用户拥有管理聊天室的完整聊天室权限,包括:

  • 将聊天室中其他成员的角色更改为成员、管理员或所有者。
  • 删除聊天室。

仅在 SpaceType.SPACE(已命名的聊天室)中受支持。

如需了解详情,请参阅详细了解您作为聊天室所有者或管理员的角色

群组

Google Chat 中的 Google 群组。

JSON 表示法
{
  "name": string
}
字段
name

string

Google 群组的资源名称。

表示 Cloud Identity Groups API 中的群组

格式:groups/{group}

方法

create

为通话 Chat 应用、用户或 Google 群组创建会员资格。

delete

删除会员资格。

get

返回有关会员资格的详细信息。

list

列出空间中的会员。

patch

更新会员资格。