Method: people.getBatchGet

Fournit des informations sur une liste de personnes spécifiques en spécifiant une liste de noms de ressources demandés. Utilisez people/me pour indiquer l'utilisateur authentifié.

La requête renvoie une erreur 400 si "personFields" n'est pas spécifié.

Requête HTTP

GET https://people.googleapis.com/v1/people:batchGet

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
resourceNames[]

string

Obligatoire. Noms des ressources des personnes pour lesquelles vous souhaitez fournir des informations. Il est reproductible. Le paramètre de requête de l'URL doit être

resourceNames=<name1>&resourceNames=<name2>&...

  • Pour obtenir des informations sur l'utilisateur authentifié, spécifiez people/me.
  • Pour obtenir des informations sur un compte Google, spécifiez people/{account_id}.
  • Pour obtenir des informations sur un contact, spécifiez le nom de la ressource qui l'identifie, tel que renvoyé par people.connections.list.

Le nombre maximal de noms de ressources est de 200.
requestMask
(deprecated)

object (RequestMask)

OBSOLÈTE (veuillez utiliser personFields à la place)

Masque permettant de limiter les résultats à un sous-ensemble de champs de personne.
personFields

string (FieldMask format)

Obligatoire. Masque de champ permettant de restreindre les champs de chaque personne renvoyés. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. 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 cette valeur n'est pas définie, la valeur par défaut est READ_SOURCE_TYPE_CONTACT et READ_SOURCE_TYPE_PROFILE.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Réponse à une requête "get" pour obtenir une liste de personnes par nom de ressource.

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

Représentation JSON 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
Champs
responses[]

object (PersonResponse)

Réponse pour chaque nom de ressource demandé.

Champs d'application des autorisations

Aucune autorisation n'est requise pour accéder aux données publiques. Pour les données privées, l'un des champs d'application OAuth suivants est obligatoire:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

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