Method: people.batchUpdateContacts

Atualize um lote de contatos e retorne um mapa de nomes de recursos a PersonResponses para os contatos atualizados.

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

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

Corpo da solicitação

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

Representação JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Campos
contacts

map (key: string, value: object (Person))

Obrigatório. Um mapa de nomes de recursos para os dados de pessoas a serem atualizados. Permite até 200 contatos em uma única solicitação.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos da pessoa são atualizados. Vários campos podem ser especificados separados por vírgulas. Todos os campos especificados serão substituídos ou apagados se forem deixados em branco para cada pessoa. Os valores válidos são:

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

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos são retornados em cada pessoa. Vários campos podem ser especificados separados por vírgulas. Se a máscara de leitura for deixada em branco, a tag post-mutate-get será ignorada e nenhum dado será retornado na resposta. Os valores válidos são:

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

enum (ReadSourceType)

Opcional. Uma máscara de quais tipos de origem serão retornados. Se não for definido, o padrão será READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE.

Corpo da resposta

Em caso de falha, retorna BatchUpdateContactsErrorDetails, uma lista de erros correspondentes a cada contato.

A resposta a uma solicitação para atualizar um lote de contatos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Campos
updateResult

map (key: string, value: object (PersonResponse))

Um mapa de nomes de recursos para os contatos que foram atualizados, a menos que a solicitação readMask esteja vazia.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

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.