Method: people.searchDirectoryPeople

Fournit une liste de profils du domaine et de contacts du domaine dans l'annuaire du domaine de l'utilisateur authentifié correspondant à 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 avec préfixe correspondant aux champs de la personne. N'utilise PAS le 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
  • tranches d'âge
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • photosdecouverture
  • emailAddresses
  • événements
  • ID externes
  • critères de sexe
  • ImClients
  • centres d'intérêt
  • locales
  • zones géographiques
  • aux chaînes
  • metadata
  • Divers mots clés
  • names
  • pseudonymes
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • SipAddresses
  • skills
  • URL
  • défini par l'utilisateur
sources[]

enum (DirectorySourceType)

Obligatoire. Sources de l'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 configurée ou si elle est définie sur 0.

pageToken

string

Facultatif. Jeton de page, reçu d'une réponse nextPageToken précédente. 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 qui a fourni le jeton de page.

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 des données qui ont la structure suivante :

Réponse à une requête portant sur des personnes du répertoire de domaine de l'utilisateur authentifié qui correspondent à la requête spécifiée.

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

object (Person)

Liste des contacts 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.