Method: people.listDirectoryPeople

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

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

Quando viene specificato pageToken o syncToken, 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 di lettura dopo scrittura.

Consulta l'esempio di utilizzo in Elenca gli utenti della directory che sono stati modificati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di query

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:

  • 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 1000 inclusi. Il valore predefinito è 100 se non viene configurato o se viene impostato su 0.
pageToken

string

(Facoltativo) Un token di pagina ricevuto da una risposta precedente nextPageToken. Fornisci 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 di pagina.
requestSyncToken

boolean

(Facoltativo) Indica se la risposta deve restituire nextSyncToken. Può essere utilizzata 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

(Facoltativo) Un token di sincronizzazione, ricevuto da una risposta precedente nextSyncToken Fornisci questo elemento 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 per la 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 delle 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 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.