Method: people.batchUpdateContacts

Einen Batch von Kontakten aktualisieren und für die aktualisierten Kontakte eine Karte mit Ressourcennamen an „PersonResponses“ zurückgeben

Änderungsanfragen für denselben Nutzer sollten sequenziell 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 Personendaten, die aktualisiert werden sollen. Bis zu 200 Kontakte in einer einzelnen Anfrage sind zulässig.

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, um einzuschränken, welche Felder für die Person aktualisiert werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Alle angegebenen Felder werden ersetzt oder gelöscht, wenn sie für jede Person leer bleiben. Gültige Werte sind:

  • Adressen
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • miscKeywords
  • Namen
  • Spitznamen
  • Berufe
  • Organisationen
  • phoneNumbers
  • Beziehungen
  • sipAddresses
  • URLs
  • userDefined
readMask

string (FieldMask format)

Erforderlich. Eine Feldmaske, um einzuschränken, welche Felder für jede Person zurückgegeben werden. Sie können mehrere Felder angeben, indem Sie sie durch Kommas trennen. Wenn die Lesemaske leer bleibt, wird post-mutate-get übersprungen und in der Antwort werden keine Daten zurückgegeben. Gültige Werte sind:

  • Adressen
  • ageRanges
  • Biografien
  • Geburtstage
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • Veranstaltungen
  • externalIds
  • geschlechter
  • imClients
  • Interessen
  • locales
  • Standorte
  • mitgliedschaft
  • Metadaten
  • miscKeywords
  • Namen
  • Spitznamen
  • Berufe
  • Organisationen
  • phoneNumbers
  • Fotos
  • Beziehungen
  • sipAddresses
  • skills
  • URLs
  • userDefined
sources[]

enum (ReadSourceType)

Optional. Eine Maske der zurückzugebenden Quelltypen. Wenn kein Wert festgelegt ist, werden standardmäßig READ_SOURCE_TYPE_CONTACT und READ_SOURCE_TYPE_PROFILE verwendet.

Antworttext

Wenn der Vorgang nicht erfolgreich war, wird BatchUpdateContactsErrorDetails zurückgegeben, d. h. eine Liste mit Fehlern, die jedem Kontakt entsprechen.

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 Kontakten, die aktualisiert wurden, 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.