Method: people.searchDirectoryPeople

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

string

obbligatorio. Aggiungi un prefisso alla query che corrisponde ai campi relativi alla persona. NON utilizza readMask per determinare i campi da abbinare.

readMask

string (FieldMask format)

obbligatorio. Una maschera di campo per limitare i campi restituiti per ogni persona. È possibile specificare più campi separandoli con virgole. I valori validi sono:

  • addresses
  • ageRanges
  • biografie
  • compleanni
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventi
  • externalIds
  • generi
  • imClients
  • interessi
  • locales
  • posizioni
  • memberships
  • metadati
  • miscKeywords
  • names
  • nickname
  • occupazioni
  • organizations
  • phoneNumbers
  • foto
  • relazioni
  • sipAddresses
  • grandi imprese
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

obbligatorio. Origini directory da restituire.

mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

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

string

Campo facoltativo. Un token di pagina, ricevuto da una risposta precedente nextPageToken. Specifica questo valore per recuperare la pagina successiva.

Durante l'impaginazione, tutti gli altri parametri forniti a [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] devono corrispondere alla prima chiamata che ha fornito il token della pagina.

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 (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 impaginazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

  • https://www.googleapis.com/auth/directory.readonly

Per ulteriori informazioni, consulta la guida all'autorizzazione.