Method: contactGroups.update

Atualize o nome de um grupo de contatos do usuário autenticado.

Os nomes atualizados dos grupos de contatos precisam ser exclusivos dos grupos de contato dos usuários. A tentativa de criar um grupo com um nome duplicado retornará um erro HTTP 409.

As solicitações de modificação para o mesmo usuário devem ser enviadas sequencialmente para evitar aumento de latência e falhas.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
contactGroup.resourceName

string

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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
}
Campos
contactGroup.etag

string

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

object (ContactGroupMetadata)

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

enum (GroupType)

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

string

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

No contactGroups.create ou no contactGroups.update, o nome precisa ser exclusivo dos grupos de contato dos usuários. A tentativa de criar um grupo com um nome duplicado retornará um erro HTTP 409.
contactGroup.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 ao nome.
contactGroup.memberResourceNames[]

string

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

integer

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

object (GroupClientData)

Os dados de clientes do grupo.
updateGroupFields

string (FieldMask format)

Opcional. Uma máscara de campo para restringir quais campos do grupo são atualizados. Vários campos podem ser especificados separados por vírgulas. O padrão será name se não for definido ou se for definido como vazio. Os campos atualizados são substituídos. Os valores válidos são:

  • clientData
  • nome
readGroupFields

string (FieldMask format)

Opcional. Uma máscara de campo para restringir quais campos do grupo são retornados. O padrão será metadata, groupType e name se não for definido ou se for definido como vazio. Os campos válidos são:

  • clientData
  • groupType
  • memberCount
  • metadados
  • nome

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de ContactGroup.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte o Guia de autorização.