Method: people.batchCreateContacts

Créer un lot de nouveaux contacts et renvoyer les réponses PersonResponses pour la nouvelle

Les requêtes de mutation pour un même utilisateur doivent être envoyées de manière séquentielle afin d'éviter une augmentation de la latence et des échecs.

Requête HTTP

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

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": [
    {
      object (ContactToCreate)
    }
  ],
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Champs
contacts[]

object (ContactToCreate)

Obligatoire. Contact à créer. Jusqu'à 200 contacts peuvent être inclus dans une même requête.
readMask

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs renvoyés pour chaque personne dans la réponse. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. Si le masque de lecture est vide, la méthode post-mutate-get est ignorée et aucune donnée n'est renvoyée dans la réponse. Les valeurs possibles 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
  • emplacement
  • aux chaînes
  • métadonnées
  • miscKeywords
  • names
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Facultatif. Masque les types de sources à renvoyer dans la lecture post-mutate. La valeur par défaut est READ_SOURCE_TYPE_CONTACT, et READ_SOURCE_TYPE_PROFILE si ce n'est pas le cas.

Corps de la réponse

Si l'opération échoue, renvoie BatchCreateContactsErrorDetails, qui contient la liste des erreurs pour chaque contact non valide.

Réponse à une requête de création 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 
{
  "createdPeople": [
    {
      object (PersonResponse)
    }
  ]
}
Champs
createdPeople[]

object (PersonResponse)

Contacts qui ont été créés, sauf si la requête readMask est vide.

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.

ContactToCreate

Wrapper contenant les données de la personne pour renseigner une nouvelle source.

Représentation JSON 
{
  "contactPerson": {
    object (Person)
  }
}
Champs
contactPerson

object (Person)

Obligatoire. Données sur les personnes à renseigner dans une nouvelle source.