- Richiesta HTTP
- Parametri di ricerca
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Prova!
Fornisce un elenco dei profili e dei contatti del dominio della 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 ricerca
Parametri | |
---|---|
query |
obbligatorio. Aggiungi un prefisso alla query che corrisponde ai campi relativi alla persona. NON utilizza readMask per determinare i campi da abbinare. |
readMask |
obbligatorio. Una maschera di campo per limitare i campi restituiti per ogni persona. È possibile specificare più campi separandoli con virgole. I valori validi sono:
|
sources[] |
obbligatorio. Origini directory da restituire. |
mergeSources[] |
Campo facoltativo. Dati aggiuntivi da unire alle origini della directory se queste sono connesse tramite chiavi di join verificate come indirizzi email o numeri di telefono. |
pageSize |
Campo facoltativo. Il numero di persone da includere nella risposta. I valori validi sono compresi tra 1 e 500 inclusi. Se non viene configurato o se viene impostato su 0, il valore predefinito è 100. |
pageToken |
Campo facoltativo. Un token di pagina, ricevuto da una risposta precedente Durante l'impaginazione, tutti gli altri parametri forniti a [ |
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
La risposta a una richiesta di utenti nella directory del dominio dell'utente autenticato che corrispondono alla query specificata.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
Rappresentazione JSON |
---|
{
"people": [
{
object ( |
Campi | |
---|---|
people[] |
L'elenco di persone nella directory del dominio che corrispondono alla query. |
nextPageToken |
Un token, che può essere inviato come |
totalSize |
Il numero totale di elementi nell'elenco senza impaginazione. |
Ambiti di autorizzazione
Richiede il seguente ambito OAuth:
https://www.googleapis.com/auth/directory.readonly
Per ulteriori informazioni, consulta la guida all'autorizzazione.