REST Resource: contactGroups

Resource: ContactGroup

A contact group.

JSON representation 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Fields
resourceName

string

The resource name for the contact group, assigned by the server. An ASCII string, in the form of contactGroups/{contactGroupId}.
etag

string

The HTTP entity tag of the resource. Used for web cache validation.
metadata

object (ContactGroupMetadata)

Output only. Metadata about the contact group.
groupType

enum (GroupType)

Output only. The contact group type.
name

string

The contact group name set by the group owner or a system provided name for system groups.

For contactGroups.create or contactGroups.update the name must be unique to the users contact groups. Attempting to create a group with a duplicate name will return a HTTP 409 error.
formattedName

string

Output only. The name translated and formatted in the viewer's account locale or the Accept-Language HTTP header locale for system groups names. Group names set by the owner are the same as name.
memberResourceNames[]

string

Output only. The list of contact person resource names that are members of the contact group. The field is only populated for GET requests and will only return as many members as maxMembers in the get request.
memberCount

integer

Output only. The total number of contacts in the group irrespective of max members in specified in the request.
clientData[]

object (GroupClientData)

The group's client data.

ContactGroupMetadata

The metadata about a contact group.

JSON representation 
{
  "updateTime": string,
  "deleted": boolean
}
Fields
updateTime

string (Timestamp format)

Output only. The time the group was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Output only. True if the contact group resource has been deleted. Populated only for contactGroups.list requests that include a sync token.

GroupType

A contact group type.

Enums
GROUP_TYPE_UNSPECIFIED Unspecified.
USER_CONTACT_GROUP User defined contact group.
SYSTEM_CONTACT_GROUP System defined contact group.

GroupClientData

Arbitrary client data that is populated by clients. Duplicate keys and values are allowed.

JSON representation 
{
  "key": string,
  "value": string
}
Fields
key

string

The client specified key of the client data.
value

string

The client specified value of the client data.

Methods

batchGet

 Get a list of contact groups owned by the authenticated user by specifying a list of contact group resource names.

create

 Create a new contact group owned by the authenticated user.

delete

 Delete an existing contact group owned by the authenticated user by specifying a contact group resource name.

get

 Get a specific contact group owned by the authenticated user by specifying a contact group resource name.

list

 List all contact groups owned by the authenticated user.

update

 Update the name of an existing contact group owned by the authenticated user.