- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- Faça um teste
Atualizar os dados de contato de uma pessoa Os dados sem contato não serão modificados. Todos os dados não relacionados a contatos da pessoa a ser atualizada serão ignorados. Todos os campos especificados em updateMask
serão substituídos.
O servidor vai retornar um erro 400 se person.metadata.sources
não for especificado para atualizar o contato ou se não houver uma origem de contato.
O servidor vai 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 mudou desde que os dados foram lidos. Os clientes precisam receber a pessoa mais recente e mesclar as atualizações dela. Se você fizer atualizações sequenciais para a mesma pessoa, use o etag da resposta updateContact
para evitar falhas.
O servidor vai retornar um erro 400 se memberships
estiver sendo atualizado e não houver nenhum grupo de contatos especificado na pessoa.
O servidor vai retornar um erro 400 se mais de um campo for especificado em um campo que é único para as origens de contato:
- biografias
- aniversários
- sexos
- nomes
As solicitações de mutação para o mesmo usuário precisam ser enviadas sequencialmente para evitar maior latência e 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 |
O nome do recurso da pessoa, atribuído pelo servidor. Uma string ASCII no formato |
Parâmetros de consulta
Parâmetros | |
---|---|
updatePersonFields |
Obrigatório. Uma máscara de campo para restringir quais campos da pessoa são atualizados. É possível especificar vários campos separando-os com vírgulas. Todos os campos atualizados serão substituídos. Os valores válidos são:
|
personFields |
Opcional. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separando-os com vírgulas. O padrão é todos os campos, se não for definido. Os valores válidos são:
|
sources[] |
Opcional. Uma máscara dos tipos de origem a serem retornados. O padrão é |
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.