Method: people.batchUpdateContacts

Aggiorna un gruppo di contatti e restituisci una mappa dei nomi delle risorse a PersonResponses per i contatti aggiornati.

Le richieste modificate per lo stesso utente devono essere inviate in sequenza per evitare un aumento della latenza e degli errori.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Campi
contacts

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

obbligatorio. Una mappa dei nomi delle risorse con i dati delle persone da aggiornare. Consente fino a 200 contatti in una singola richiesta.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

updateMask

string (FieldMask format)

obbligatorio. Una maschera di campo per limitare i campi aggiornati per la persona. È possibile specificare più campi separandoli con virgole. Tutti i campi specificati verranno sostituiti o cancellati se lasciati vuoti per ogni persona. I valori validi sono:

  • addresses
  • biografie
  • compleanni
  • calendarUrls
  • clientData
  • emailAddresses
  • eventi
  • externalIds
  • generi
  • imClients
  • interessi
  • locales
  • posizioni
  • memberships
  • miscKeywords
  • names
  • nickname
  • occupazioni
  • organizations
  • phoneNumbers
  • relazioni
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

obbligatorio. Una maschera di campo per limitare i campi restituiti per ogni persona. È possibile specificare più campi separandoli con virgole. Se la maschera di lettura viene lasciata vuota, il comando post-mutate-get viene ignorato e non vengono restituiti dati nella risposta. I valori validi sono:

  • addresses
  • ageRanges
  • biografie
  • compleanni
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventi
  • externalIds
  • generi
  • imClients
  • interessi
  • locales
  • posizioni
  • memberships
  • metadati
  • miscKeywords
  • names
  • nickname
  • occupazioni
  • organizations
  • phoneNumbers
  • foto
  • relazioni
  • sipAddresses
  • grandi imprese
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Campo facoltativo. Una maschera dei tipi di origine da restituire. Se non viene configurato, il valore predefinito è READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE.

Corpo della risposta

Se l'operazione non va a buon fine, restituisce BatchUpdateContactsErrorDetails, un elenco di errori corrispondenti a ciascun contatto.

La risposta a una richiesta di aggiornamento di un gruppo di contatti.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Campi
updateResult

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

Una mappa dei nomi delle risorse per i contatti che sono stati aggiornati, a meno che la richiesta readMask non sia vuota.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la guida all'autorizzazione.