Method: people.connections.list

Fornisce un elenco dei contatti dell'utente autenticato.

I token di sincronizzazione scadono sette giorni dopo la sincronizzazione completa. Una richiesta con un token di sincronizzazione scaduto riceverà un errore con un errore google.rpc.ErrorInfo con il motivo "EXPIRED_SYNC_TOKEN". In caso di errore di questo tipo, i client devono effettuare una richiesta di sincronizzazione completa senza syncToken.

La prima pagina di una richiesta di sincronizzazione completa ha una quota aggiuntiva. Se la quota viene superata, verrà restituito un errore 429. Questa quota è fissa e non può essere aumentata.

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.

Esamina l'utilizzo di esempio in Elenca i contatti dell'utente che sono stati modificati.

Richiesta HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
resourceName
(deprecated)

string

obbligatorio. Il nome della risorsa per cui restituire le connessioni. È valido solo people/me.

Parametri di ricerca

Parametri
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.connections.list devono corrispondere alla prima chiamata che ha fornito il token della pagina.
pageSize

integer

Campo facoltativo. Il numero di connessioni 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.
sortOrder

enum (SortOrder)

Campo facoltativo. L'ordine in cui devono essere ordinate le connessioni. Il valore predefinito è LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

Campo facoltativo. Indica se la risposta deve restituire nextSyncToken nell'ultima pagina dei risultati. 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.connections.list.
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.connections.list devono corrispondere alla prima chiamata che ha fornito il token di sincronizzazione.

Ulteriori dettagli sul comportamento di sincronizzazione sono disponibili all'indirizzo people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Campo facoltativo. OBSOLETO (utilizza invece personFields)

Una maschera per limitare i risultati a un sottoinsieme di campi persona.
personFields

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 (ReadSourceType)

Campo facoltativo. Una maschera dei tipi di origine da restituire. Se non viene configurato, il valore predefinito è READ_SOURCE_TYPE_CONTACT e READ_SOURCE_TYPE_PROFILE.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta a una richiesta di connessioni dell'utente autenticato.

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

Rappresentazione JSON 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Campi
connections[]

object (Person)

L'elenco di persone a cui è collegato il richiedente.
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. Quando la risposta viene impaginata, solo l'ultima pagina conterrà nextSyncToken.
totalPeople
(deprecated)

integer

OBSOLETO (Utilizza totalItems) Il numero totale di persone nell'elenco senza impaginazione.
totalItems

integer

Il numero totale di elementi nell'elenco senza impaginazione.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la guida all'autorizzazione.

SortOrder

L'ordine in cui deve essere ordinato un elenco di connessioni. Viene utilizzato solo se non è richiesta la sincronizzazione.

Enum
LAST_MODIFIED_ASCENDING Ordina gli utenti in base alla data di modifica; per prima cosa, seleziona le voci meno recenti.
LAST_MODIFIED_DESCENDING Ordina le persone in base a quando sono state modificate; per prima le voci più recenti.
FIRST_NAME_ASCENDING Ordina le persone per nome.
LAST_NAME_ASCENDING Ordina le persone per cognome.