Method: people.listDirectoryPeople

Fornisce un elenco dei profili e dei contatti del dominio nella directory del dominio dell'utente autenticato.

Se viene specificato syncToken, le risorse eliminate dall'ultima sincronizzazione verranno restituite come utente con PersonMetadata.deleted impostato su true.

Quando pageToken o syncToken è specificato, tutti gli altri parametri della richiesta devono corrispondere alla prima chiamata.

Le scritture potrebbero avere un ritardo di propagazione di diversi minuti per le richieste di sincronizzazione. Le sincronizzazioni incrementali non sono destinate ai casi d'uso lettura-dopo-scrittura.

Consulta un esempio di utilizzo in Elenca le persone della directory che sono state modificate.

Richiesta HTTP

GET https://people.googleapis.com/v1/people:listDirectoryPeople

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
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 1000 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.listDirectoryPeople devono corrispondere alla prima chiamata che ha fornito il token della pagina.
requestSyncToken

boolean

Campo facoltativo. Se la risposta deve restituire nextSyncToken. Può essere utilizzato per ottenere modifiche incrementali dall'ultima richiesta impostandola sulla richiesta syncToken.

Ulteriori dettagli sul comportamento di sincronizzazione sono disponibili all'indirizzo people.listDirectoryPeople.
syncToken

string

Campo facoltativo. Un token di sincronizzazione, ricevuto da una risposta precedente nextSyncToken Specifica questo valore per recuperare solo le risorse modificate dall'ultima richiesta.

Durante la sincronizzazione, tutti gli altri parametri forniti a people.listDirectoryPeople devono corrispondere alla prima chiamata che ha fornito il token di sincronizzazione.

Ulteriori dettagli sul comportamento di sincronizzazione sono disponibili all'indirizzo people.listDirectoryPeople.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta a una richiesta relativa alla directory del dominio dell'utente autenticato.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Campi
people[]

object (Person)

L'elenco di persone nella directory del dominio.
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.
nextSyncToken

string

Un token, che può essere inviato come syncToken per recuperare le modifiche apportate dall'ultima richiesta. La richiesta deve impostare requestSyncToken per restituire il token di sincronizzazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la guida all'autorizzazione.