Method: people.updateContact

Atualizar dados de contato de uma pessoa de contato existente. Os dados que não são de contato não serão modificados. Quaisquer dados que não sejam de contato da pessoa a serem atualizados serão ignorados. Todos os campos especificados em updateMask serão substituídos.

O servidor retornará um erro 400 se person.metadata.sources não for especificado para o contato a ser atualizado ou se não houver uma origem do contato.

O servidor retornará um erro 400 com o motivo "failedPrecondition" se person.metadata.sources.etag for diferente da etag do contato, o que indica que o contato foi alterado desde que os dados foram lidos. Os clientes devem obter a última pessoa e mesclar suas atualizações com essa última pessoa.

O servidor retornará um erro 400 se memberships estiver sendo atualizado e não houver associações a grupos de contatos especificadas na pessoa.

O servidor retornará um erro 400 se mais de um campo for especificado em um campo singleton para origens de contato:

  • biografias
  • aniversários
  • sexos
  • names

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

Solicitação HTTP

PATCH https://people.googleapis.com/v1/{person.resourceName=people/*}:updateContact

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

Parâmetros de caminho

Parâmetros
person.resourceName

string

O nome do recurso da pessoa, atribuído pelo servidor. Uma string ASCII no formato people/{person_id}.

Parâmetros de consulta

Parâmetros
updatePersonFields

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos da pessoa são atualizados. É possível especificar vários campos separados por vírgulas. Todos os campos atualizados serão substituídos. Os valores válidos são:

  • addresses
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • emailAddresses
  • events
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • miscKeywords
  • names
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • relações
  • sipAddresses
  • urls
  • userDefined
personFields

string (FieldMask format)

Opcional. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separados por vírgulas. Se não for definido, o padrão será todos os campos. Os valores válidos são:

  • addresses
  • ageRanges
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • metadados
  • miscKeywords
  • names
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • fotos
  • relações
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Uma máscara dos tipos de origem a serem retornados. O padrão será READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE, se nenhum valor for definido.

Corpo da solicitação

O corpo da solicitação contém uma instância de Person.

Corpo da resposta

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

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.