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 de ressources des personnes sur lesquelles vous souhaitez fournir des informations. Elle est reproductible. Le paramètre de requête d'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 identifie le contact tel que renvoyé par people.connections.list.

Le nombre de noms de ressources est limité à 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 limiter les champs renvoyés pour chaque personne. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. 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. 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 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 requise pour accéder aux données publiques. Pour les données privées, l'un des champs d'application OAuth suivants est requis:

  • 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.