Method: people.searchDirectoryPeople

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. Fornisci questo valore per recuperare la pagina successiva.

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.