REST Resource: contactGroups

Recurso: ContactGroup

Um grupo de contatos.

Representação JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Campos
resourceName

string

O nome do recurso para o grupo de contatos, atribuído pelo servidor. Uma string ASCII, na forma de contactGroups/{contactGroupId}.
etag

string

A tag de entidade HTTP do recurso. Usado para validação de cache da Web.
metadata

object (ContactGroupMetadata)

Apenas saída. Metadados sobre o grupo de contatos.
groupType

enum (GroupType)

Apenas saída. O tipo de grupo de contatos.
name

string

O nome do grupo de contatos definido pelo proprietário ou um nome fornecido pelo sistema para grupos do sistema.

No contactGroups.create ou no contactGroups.update, o nome precisa ser exclusivo para os grupos de contato dos usuários. A tentativa de criar um grupo com um nome duplicado retornará um erro HTTP 409.
formattedName

string

Apenas saída. O nome traduzido e formatado na localidade da conta do leitor ou na localidade do cabeçalho HTTP Accept-Language para nomes de grupos do sistema. Os nomes dos grupos definidos pelo proprietário são iguais aos do nome.
memberResourceNames[]

string

Apenas saída. A lista de nomes de recursos de pessoa de contato que são membros do grupo de contatos. O campo só é preenchido para solicitações GET e só retorna o número de membros maxMembers na solicitação GET.
memberCount

integer

Apenas saída. O número total de contatos no grupo, independentemente do número máximo de membros especificado na solicitação.
clientData[]

object (GroupClientData)

Os dados de cliente do grupo.

ContactGroupMetadata

Os metadados sobre um grupo de contatos.

Representação JSON 
{
  "updateTime": string,
  "deleted": boolean
}
Campos
updateTime

string (Timestamp format)

Apenas saída. A hora em que o grupo foi atualizado pela última vez.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Apenas saída. Verdadeiro se o recurso do grupo de contatos tiver sido excluído. Preenchido apenas para solicitações contactGroups.list que incluem um token de sincronização.

GroupType

Um tipo de grupo de contatos.

Enums
GROUP_TYPE_UNSPECIFIED Não especificado.
USER_CONTACT_GROUP Grupo de contatos definido pelo usuário.
SYSTEM_CONTACT_GROUP Grupo de contatos definido pelo sistema.

GroupClientData

Dados arbitrários do cliente preenchidos por clientes. Chaves e valores duplicados são permitidos.

Representação JSON 
{
  "key": string,
  "value": string
}
Campos
key

string

A chave especificada pelo cliente dos dados do cliente.
value

string

O valor especificado pelo cliente dos dados do cliente.

Métodos

batchGet

 Receba uma lista de grupos de contatos de propriedade do usuário autenticado. Basta especificar uma lista de nomes de recursos de grupos de contatos.

create

 Crie um novo grupo de contatos de propriedade do usuário autenticado.

delete

 Especifique um nome de recurso de grupo de contatos para excluir um grupo de contatos existente de propriedade do usuário autenticado.

get

 Especifique um nome de recurso de grupo de contatos para obter um grupo de contatos específico de propriedade do usuário autenticado.

list

 Lista todos os grupos de contatos do usuário autenticado.

update

 Atualize o nome de um grupo de contatos existente que pertença ao usuário autenticado.