Method: people.batchUpdateContacts

Einen Batch von Kontakten aktualisieren und eine Zuordnung von Ressourcennamen an PersonResponses für die aktualisierten Kontakte zurückgeben.

Änderungsanfragen für denselben Nutzer sollten nacheinander gesendet werden, um erhöhte Latenz und Fehler zu vermeiden.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

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

Erforderlich. Eine Zuordnung von Ressourcennamen zu den zu aktualisierenden Personendaten. Ermöglicht bis zu 200 Kontakte in einer einzelnen Anfrage.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

updateMask

string (FieldMask format)

Erforderlich. Eine Feldmaske, mit der eingeschränkt wird, welche Felder einer Person aktualisiert werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Alle angegebenen Felder werden ersetzt oder gelöscht, wenn das Feld für jede Person leer gelassen wird. Gültige Werte sind:

  • addresses
  • biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • miscKeywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • Beziehungen
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

Erforderlich. Eine Feldmaske, mit der eingeschränkt wird, welche Felder für jede Person zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Bleibt die Lesemaske leer, wird „post-mutate-get“ übersprungen und es werden keine Daten in der Antwort zurückgegeben. Gültige Werte sind:

  • addresses
  • ageRanges
  • biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • names
  • Spitznamen
  • Berufe
  • organizations
  • phoneNumbers
  • fotos
  • Beziehungen
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske, die angibt, welche Quelltypen zurückgegeben werden sollen. Wenn kein Wert festgelegt wird, werden standardmäßig READ_SOURCE_TYPE_CONTACT und READ_SOURCE_TYPE_PROFILE verwendet.

Antworttext

Wenn nicht erfolgreich, wird BatchUpdateContactsErrorDetails zurückgegeben, eine Liste der Fehler für jeden Kontakt.

Die Antwort auf eine Anfrage zum Aktualisieren eines Batches von Kontakten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Felder
updateResult

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

Eine Zuordnung von Ressourcennamen zu den aktualisierten Kontakten, es sei denn, die Anfrage readMask ist leer.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.