Method: contactGroups.update

更新经过身份验证的用户拥有的现有联系人群组的名称。

更新后的联系人群组名称对于用户联系人群组而言必须是唯一的。尝试使用重复名称创建群组将返回 HTTP 409 错误。

应按顺序发送针对同一用户的 mutate 请求，以避免延迟时间增加和失败增加。

HTTP 请求

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

网址采用 gRPC 转码语法。

路径参数

参数
contactGroup.resourceName

string

联系人群组的资源名称，由服务器分配。ASCII 字符串，格式为 contactGroups/{contactGroupId}。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
字段
contactGroup.etag

string

资源的 HTTP 实体标记。用于网络缓存验证。
contactGroup.metadata

object (ContactGroupMetadata)

仅限输出。联系人群组的元数据。
contactGroup.groupType

enum (GroupType)

仅限输出。联系人群组类型。
contactGroup.name

string

由群组所有者设置的联系人群组名称，或系统群组为系统提供的名称。

对于 contactGroups.create 或 contactGroups.update，用户联系人群组的名称必须是唯一的。尝试使用重复名称创建群组将返回 HTTP 409 错误。
contactGroup.formattedName

string

仅限输出。根据查看者的账号语言区域或系统群组名称的 Accept-Language HTTP 标头语言区域经过翻译和格式化的名称。所有者设置的群组名称与群组名称相同。
contactGroup.memberResourceNames[]

string

仅限输出。属于联系人群组联系人的联系人资源名称列表。系统只会针对 GET 请求填充此字段，并且在 get 请求中仅返回与 maxMembers 一样多的成员。
contactGroup.memberCount

integer

仅限输出。群组中的联系人总数，与请求中指定的成员数量上限无关。
contactGroup.clientData[]

object (GroupClientData)

该群组的客户数据。
updateGroupFields

string (FieldMask format)

可选。用于限制更新组中哪些字段的字段掩码。可以指定多个字段，只需用逗号分隔即可。如果未设置或留空，则默认为 name。更新的字段将被替换。有效值包括：

  • clientData
  • name
readGroupFields

string (FieldMask format)

可选。字段掩码，用于限制返回组上的哪些字段。如果未设置或留空，则默认为 metadata、groupType 和 name。有效字段包括：

  • clientData
  • groupType
  • memberCount
  • 元数据
  • name

响应正文

如果成功，则响应正文包含一个 ContactGroup 实例。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/contacts

有关详情，请参阅授权指南。