Method: people.searchContacts

Fournit la liste des contacts regroupés de l'utilisateur authentifié qui correspondent à la requête de recherche. La requête correspond aux champs names, nickNames, emailAddresses, phoneNumbers et organizations d'un contact provenant de la source CONTACT.

IMPORTANT: Avant la recherche, les clients doivent envoyer une requête de préchauffage contenant une requête vide pour mettre à jour le cache. Voir https://developers.google.com/people/v1/contacts#search_the_users_contacts

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
query

string

Obligatoire. Requête en texte brut de la requête. La requête permet de faire correspondre des expressions de préfixe des champs d'une personne. Par exemple, une personne portant le nom "foo name" correspond aux requêtes telles que "f", "fo", "foo", "foo n", "nam", etc., mais pas "oo n".
pageSize

integer

Facultatif. Nombre de résultats à renvoyer. La valeur par défaut est 10 si le champ n'est pas défini, ou la valeur 0. Les valeurs supérieures à 30 seront limitées à 30.
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. 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. Si ce champ n'est pas spécifié, la valeur par défaut est READ_SOURCE_TYPE_CONTACT.

Corps de la requête

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

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de SearchResponse.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

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