Method: people.batchUpdateContacts

Atualiza um lote de contatos e retorna 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 em sequência para evitar o aumento da latência e as 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 da pessoa 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. É possível especificar vários campos separados por vírgulas. Todos os campos especificados serão substituídos ou apagados se ficarem em branco para cada pessoa. 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
readMask

string (FieldMask format)

Obrigatório. 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 a máscara de leitura for deixada vazia, a função post-mutate-get será ignorada e nenhum dado vai ser retornado na resposta. 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 resposta

Se não for bem-sucedido, 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.