更新经过身份验证的用户所拥有的现有联系人群组的名称。
更新后的联系人群组名称对用户联系人群组而言必须是唯一的。尝试使用重复名称创建群组将返回 HTTP 409 错误。
应按顺序发送同一用户的 mutate 请求,以避免延迟时间增加和失败。
HTTP 请求
PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
contactGroup.resourceName |
联系人群组的资源名称,由服务器分配。一个 ASCII 字符串,格式为 |
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{
"contactGroup": {
"resourceName": string,
"etag": string,
"metadata": {
"updateTime": string,
"deleted": boolean
},
"groupType": enum ( |
字段 | |
---|---|
contactGroup.etag |
资源的 HTTP 实体标记。用于验证网络缓存。 |
contactGroup.metadata |
仅供输出。关于联系人群组的元数据。 |
contactGroup.groupType |
仅供输出。联系人群组类型。 |
contactGroup.name |
群组所有者设置的联系人群组名称,或系统为系统群组提供的名称。 对于 |
contactGroup.formattedName |
仅供输出。按照查看者的帐号语言区域或 |
contactGroup.memberResourceNames[] |
仅供输出。属于联系人群组的联系人资源名称列表。此字段仅会为 GET 请求填充,并且在 get 请求中仅返回与 |
contactGroup.memberCount |
仅供输出。群组中的联系人总数,不考虑请求中指定的成员数上限。 |
contactGroup.clientData[] |
群组的客户数据。 |
updateGroupFields |
可选。用于限制更新组中的哪些字段的字段掩码。可以指定多个字段,用英文逗号分隔各个字段。如果未设置或设为空值,则默认为
|
readGroupFields |
可选。用于限制返回组中哪些字段的字段掩码。如果未设置或为空,则默认设置为
|
响应正文
如果成功,则响应正文包含一个 ContactGroup
实例。
授权范围
需要以下 OAuth 作用域:
https://www.googleapis.com/auth/contacts
有关详情,请参阅授权指南。