Method: people.searchDirectoryPeople
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Fornisce un elenco di profili e contatti del dominio nella directory del dominio dell'utente autenticato che corrispondono alla query di ricerca.
Richiesta HTTP
GET https://people.googleapis.com/v1/people:searchDirectoryPeople
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri di query
| Parametri |
query |
string
Obbligatorio. Prefisso della query che corrisponde ai campi della persona. NON utilizza la maschera di lettura per determinare i campi da associare.
|
readMask |
string (FieldMask format)
Obbligatorio. Una maschera di campo per limitare i campi di ogni persona restituiti. È possibile specificare più campi separandoli con virgole. I valori validi sono:
- indirizzi
- ageRanges
- biografie
- compleanni
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- eventi
- externalIds
- generi
- imClients
- interessi
- locales
- posizioni
- memberships
- metadati
- miscKeywords
- nomi
- nickname
- occupazioni
- organizzazioni
- phoneNumbers
- foto
- relazioni
- sipAddresses
- grandi imprese
- Url
- userDefined
|
sources[] |
enum (DirectorySourceType)
Obbligatorio. Origini delle directory da restituire.
|
mergeSources[] |
enum (DirectoryMergeSourceType)
(Facoltativo) Dati aggiuntivi da unire alle origini directory se sono collegate tramite chiavi di join verificate, ad esempio indirizzi email o numeri di telefono.
|
pageSize |
integer
(Facoltativo) Il numero di persone da includere nella risposta. I valori validi sono compresi tra 1 e 500 inclusi. Se non impostato o impostato su 0, il valore predefinito è 100.
|
pageToken |
string
(Facoltativo) Un token di pagina, ricevuto da una risposta precedente nextPageToken Quando viene applicata la paginazione, tutti gli altri parametri forniti a [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] devono corrispondere alla prima chiamata che ha fornito il token pagina.
|
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
La risposta a una richiesta di persone nella directory del dominio dell'utente autenticato corrispondenti alla query specificata.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
| Rappresentazione JSON |
{
"people": [
{
object (Person)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Campi |
people[] |
object (Person)
L'elenco di persone nella directory del dominio che corrispondono alla query.
|
nextPageToken |
string
Un token che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.
|
totalSize |
integer
Il numero totale di elementi nell'elenco senza paginazione.
|
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/directory.readonly
Per ulteriori informazioni, consulta la Guida all'autorizzazione.
Salvo quando diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0, mentre gli esempi di codice sono concessi in base alla licenza Apache 2.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-11-08 UTC.
[null,null,["Ultimo aggiornamento 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)."]]
