Method: people.searchDirectoryPeople

Fournit une liste des profils de domaine et des contacts du domaine dans l'annuaire du domaine de l'utilisateur authentifié qui correspondent à la requête de recherche.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
query

string

Obligatoire. Requête de préfixe qui correspond aux champs de la personne. N'utilise PAS readMask pour déterminer les champs à mettre en correspondance.
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 (DirectorySourceType)

Obligatoire. Sources d'annuaire à afficher.
mergeSources[]

enum (DirectoryMergeSourceType)

Facultatif. Données supplémentaires à fusionner dans les sources d'annuaire si elles sont connectées via des clés de jointure validées telles que des adresses e-mail ou des numéros de téléphone.
pageSize

integer

Facultatif. Nombre de personnes à inclure dans la réponse. Les valeurs valides sont comprises entre 1 et 500 inclus. La valeur par défaut est 100 si elle n'est pas définie ou si elle est définie sur 0.
pageToken

string

Facultatif. Un jeton de page, reçu à partir d'une réponse précédente nextPageToken. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] doivent correspondre au premier appel ayant fourni le jeton de page.

Corps de la requête

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

Corps de la réponse

Réponse à une requête destinée aux personnes figurant dans l'annuaire de domaine de l'utilisateur authentifié et correspondant à la requête spécifiée.

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

Représentation JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Champs
people[]

object (Person)

Liste des personnes de l'annuaire du domaine qui correspondent à la requête.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
totalSize

integer

Nombre total d'éléments dans la liste sans pagination.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

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