Method: people.batchUpdateContacts

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

Las solicitudes de mutación del mismo usuario se deben enviar de forma secuencial para evitar una mayor 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 los nombres de los recursos a los datos de la persona que se actualizarán. Permite hasta 200 contactos por 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 que se actualizan en la persona. Se pueden especificar varios campos separándolos con comas. Todos los campos especificados se reemplazarán o se borrarán si se dejan vacíos para cada persona. A continuación, se indican los valores válidos:

  • addresses
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • relaciones
  • direccionessip
  • url
  • definido por el usuario
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran en 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. A continuación, se indican los valores válidos:

  • addresses
  • Rangos de edad
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • fotos de portada
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadata
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • fotos
  • relaciones
  • direccionessip
  • skills
  • url
  • definido por el usuario
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 se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

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

La respuesta a una solicitud para actualizar un lote de contactos.

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

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

Un mapa con los nombres de los 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 la 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.