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 el aumento de la latencia y las 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. Es una asignación de los nombres de los recursos a los datos de las 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 para restringir qué campos de la persona se deben actualizar. Se pueden especificar varios campos separándolos con comas. Se reemplazarán todos los campos especificados o se borrarán si dejan vacíos para cada persona. Estos son los valores válidos:

  • direcciones
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizaciones
  • phoneNumbers
  • relaciones
  • sipAddresses
  • url
  • userDefined
readMask

string (FieldMask format)

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

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

enum (ReadSourceType)

Opcional. Es una máscara de los tipos de fuentes que se mostrarán. El valor predeterminado es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE si no está configurado.

Cuerpo de la respuesta

Si no se realiza correctamente, muestra BatchUpdateContactsErrorDetails, una lista de errores correspondientes 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 nombres de recursos para 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" }.

Alcances 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.