REST Resource: contactGroups

资源：ContactGroup

联系人群组。

JSON 表示法 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
字段
resourceName

string

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

string

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

object (ContactGroupMetadata)

仅限输出。关于联系人群组的元数据。
groupType

enum (GroupType)

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

string

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

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

string

仅限输出。按照查看者的帐号语言区域或 Accept-Language HTTP 标头语言区域（用于系统群组名称）翻译和格式化的名称。所有者设置的群组名称与群组名称相同。
memberResourceNames[]

string

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

integer

仅限输出。群组中的联系人总数，不考虑请求中指定的成员数上限。
clientData[]

object (GroupClientData)

群组的客户数据。

ContactGroupMetadata

联系人群组的相关元数据。

JSON 表示法 
{
  "updateTime": string,
  "deleted": boolean
}
字段
updateTime

string (Timestamp format)

仅限输出。上次更新群组的时间。

采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式的时间戳，采用纳秒级精度，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
deleted

boolean

仅限输出。如果联系人群组资源已删除，则为 true。仅为包含同步令牌的 contactGroups.list 请求填充。

GroupType

一种联系人群组类型。

枚举
GROUP_TYPE_UNSPECIFIED 未指定。
USER_CONTACT_GROUP 用户定义的联系人群组。
SYSTEM_CONTACT_GROUP 系统定义的联系人群组。

GroupClientData

由客户端填充的任意客户端数据。允许存在重复的键和值。

JSON 表示法 
{
  "key": string,
  "value": string
}
字段
key

string

客户端数据的客户端指定键。
value

string

客户端指定客户端数据的值。

方法

batchGet

 通过指定联系人群组资源名称列表，获取经过身份验证的用户拥有的联系人群组列表。

create

 创建由经过身份验证的用户拥有的新联系人群组。

delete

 通过指定联系人群组资源名称，删除经过身份验证的用户拥有的现有联系人群组。

get

 通过指定联系人群组资源名称，获取已验证用户拥有的特定联系人群组。

list

 列出经过身份验证的用户拥有的所有联系人群组。

update

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