Method: people.batchUpdateContacts

Mettre à jour un lot de contacts et renvoyer un mappage des noms de ressources à PersonResponses pour les contacts mis à jour

Les requêtes de mutation pour le même utilisateur doivent être envoyées de manière séquentielle pour éviter une latence accrue et des échecs.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Champs
contacts

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

Obligatoire. Mappage des noms des ressources avec les données de la personne à mettre à jour. Vous pouvez autoriser jusqu'à 200 contacts par requête.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
updateMask

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs de la personne qui sont mis à jour. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. Tous les champs spécifiés seront remplacés ou effacés s'ils sont laissés vides pour chaque personne. Les valeurs valides sont les suivantes :

  • addresses
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • emailAddresses
  • événements
  • externalIds
  • critères de sexe
  • imClients
  • centres d'intérêt
  • locales
  • zones géographiques
  • aux chaînes
  • miscKeywords
  • noms
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • relations
  • sipAddresses
  • URL
  • userDefined
readMask

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs renvoyés pour chaque personne. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. Si le masque de lecture est vide, la commande post-mutate-get est ignorée et aucune donnée n'est renvoyée dans la réponse. Les valeurs valides sont les suivantes :

  • addresses
  • ageRanges
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • événements
  • externalIds
  • critères de sexe
  • imClients
  • centres d'intérêt
  • locales
  • zones géographiques
  • aux chaînes
  • métadonnées
  • miscKeywords
  • noms
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

Facultatif. Masque des types de sources à renvoyer. Si ce champ n'est pas défini, la valeur par défaut est READ_SOURCE_TYPE_CONTACT et READ_SOURCE_TYPE_PROFILE.

Corps de la réponse

En cas d'échec, renvoie BatchUpdateContactsErrorDetails, une liste d'erreurs correspondant à chaque contact.

Réponse à une requête de mise à jour d'un lot de contacts.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Champs
updateResult

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

Mappage des noms de ressources vers les contacts qui ont été mis à jour, sauf si la requête readMask est vide.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.