Method: people.searchDirectoryPeople
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Fournit une liste des profils de domaine et des contacts de domaine dans l'annuaire de 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 de préfixe correspondant 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 restreindre les champs de chaque personne renvoyés. Vous pouvez spécifier plusieurs champs en les séparant par des virgules. 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
- pseudos
- professions
- organizations
- phoneNumbers
- photos
- relations
- sipAddresses
- skills
- URL
- userDefined
|
sources[] |
enum (DirectorySourceType)
Obligatoire. Sources de répertoires à afficher.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
Facultatif. Données supplémentaires à fusionner dans les sources d'annuaire si celles-ci 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. Jeton de page, reçu d'une réponse précédente nextPageToken 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 de personnes dans l'annuaire de domaine de l'utilisateur authentifié 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 du répertoire du domaine correspondant à 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 d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/11/08 (UTC).
[null,null,["Dernière mise à jour le 2024/11/08 (UTC)."],[[["\u003cp\u003eSearch for people in your domain directory using a prefix query that matches various person fields.\u003c/p\u003e\n"],["\u003cp\u003eCustomize the search by specifying fields to return, directory sources, and optional data merging.\u003c/p\u003e\n"],["\u003cp\u003eResults are paginated with controls for page size and retrieval of subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/directory.readonly\u003c/code\u003e scope for read access to the directory.\u003c/p\u003e\n"]]],["This describes how to search for people in a domain directory. Use a `GET` request to `https://people.googleapis.com/v1/people:searchDirectoryPeople`. Required query parameters include `query`, `readMask`, and `sources`. Optional parameters are `mergeSources`, `pageSize`, and `pageToken`. The request body is empty. The response contains a list of matching `people`, `nextPageToken` for pagination, and `totalSize`. Requires `directory.readonly` authorization scope.\n"],null,["# Method: people.searchDirectoryPeople\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.SearchDirectoryPeopleResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nProvides a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.\n\n### HTTP request\n\n`GET https://people.googleapis.com/v1/people:searchDirectoryPeople`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. Prefix query that matches fields in the person. Does NOT use the readMask for determining what fields to match. |\n| `readMask` | `string (`[FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMask)` format)` Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: - addresses - ageRanges - biographies - birthdays - calendarUrls - clientData - coverPhotos - emailAddresses - events - externalIds - genders - imClients - interests - locales - locations - memberships - metadata - miscKeywords - names - nicknames - occupations - organizations - phoneNumbers - photos - relations - sipAddresses - skills - urls - userDefined |\n| `sources[]` | `enum (`[DirectorySourceType](/people/api/rest/v1/DirectorySourceType)`)` Required. Directory sources to return. |\n| `mergeSources[]` | `enum (`[DirectoryMergeSourceType](/people/api/rest/v1/DirectoryMergeSourceType)`)` Optional. Additional data to merge into the directory sources if they are connected through verified join keys such as email addresses or phone numbers. |\n| `pageSize` | `integer` Optional. The number of people to include in the response. Valid values are between 1 and 500, inclusive. Defaults to 100 if not set or set to 0. |\n| `pageToken` | `string` Optional. A page token, received from a previous response [`nextPageToken`](/people/api/rest/v1/people/searchDirectoryPeople#body.SearchDirectoryPeopleResponse.FIELDS.next_page_token). Provide this to retrieve the subsequent page. When paginating, all other parameters provided to \\[`people.searchDirectoryPeople`\\]\\[google.people.v1.SearchDirectoryPeople\\] must match the first call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response to a request for people in the authenticated user's domain directory that match the specified query.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"people\": [ { object (/people/api/rest/v1/people#Person) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `people[]` | `object (`[Person](/people/api/rest/v1/people#Person)`)` The list of people in the domain directory that match the query. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n| `totalSize` | `integer` The total number of items in the list without pagination. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/directory.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
