Method: people.batchCreateContacts

Créez un lot de nouveaux contacts et renvoyez les PersonResponses pour les nouveaux

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: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. Vous pouvez autoriser jusqu'à 200 contacts par requête.

readMask

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs de chaque personne renvoyés 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 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 dans la lecture mutate de la publication. 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 BatchCreateContactsErrorDetails, qui contient une liste d'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 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 qui contient les données sur les personnes pour renseigner une source nouvellement créée.

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

object (Person)

Obligatoire. Données sur les personnes pour renseigner une source nouvellement créée.