Method: people.batchUpdateContacts

Actualiza un lote de contactos y muestra un mapa de nombres de recursos a PersonResponses para los contactos actualizados.

Las solicitudes de modificación para el mismo usuario deben enviarse de forma secuencial para evitar aumentos de latencia y fallas.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Campos
contacts

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

Obligatorio. Un mapa de nombres de recursos para los datos de personas que se actualizarán. Permite hasta 200 contactos en una sola solicitud.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos de la persona que se actualizan. Se pueden especificar varios campos separándolos con comas. Todos los campos especificados se reemplazarán o se borrarán si se deja vacío para cada persona. Estos son los valores válidos:

  • addresses
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • de ubicaciones
  • memberships
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizations
  • phoneNumbers
  • relaciones
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran de cada persona. Se pueden especificar varios campos separándolos con comas. Si la máscara de lectura se deja vacía, se omite post-mutate-get y no se mostrarán datos en la respuesta. Estos son los valores válidos:

  • addresses
  • ageRanges
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • de ubicaciones
  • memberships
  • metadatos
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizations
  • phoneNumbers
  • fotos
  • relaciones
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Una máscara de los tipos de fuentes que se mostrarán. La configuración predeterminada es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE si no se configura.

Cuerpo de la respuesta

Si no se ejecuta correctamente, muestra BatchUpdateContactsErrorDetails, una lista de errores que corresponden a cada contacto.

Es la respuesta a una solicitud para actualizar un lote de contactos.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Campos
updateResult

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

Un mapa de los nombres de los recursos de los contactos que se actualizaron, a menos que la solicitud readMask esté vacía.

Es un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la guía de autorización.