Method: people.connections.list

Fornisce un elenco dei contatti dell'utente autenticato.

I token di sincronizzazione scadono 7 giorni dopo la sincronizzazione completa. Una richiesta con token di sincronizzazione scaduto riceverà un errore google.rpc.ErrorInfo con motivo "EXPIRED_SYNC_TOKEN". In caso di un errore di questo tipo, i client devono inviare una richiesta di sincronizzazione completa senza un 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.

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 di 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 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 query

Parametri
pageToken

string

(Facoltativo) Un token di pagina ricevuto da una risposta precedente nextPageToken. Forniscilo per recuperare la pagina successiva.

Quando viene applicata la paginazione, tutti gli altri parametri forniti a people.connections.list devono corrispondere a quelli della prima chiamata che ha fornito il token pagina.
pageSize

integer

(Facoltativo) Il numero di connessioni 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.
sortOrder

enum (SortOrder)

(Facoltativo) L'ordine in cui devono essere ordinate le connessioni. Il valore predefinito è LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

(Facoltativo) Indica se la risposta deve restituire nextSyncToken nell'ultima pagina dei risultati. Può essere utilizzato per ottenere le modifiche incrementali dall'ultima richiesta impostandolo sulla richiesta syncToken.

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

string

(Facoltativo) Un token di sincronizzazione, ricevuto da una risposta precedente nextSyncToken Fornisci questa opzione 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 all'indirizzo people.connections.list.
requestMask
(deprecated)

object (RequestMask)

(Facoltativo) OBSOLETO (utilizza personFields)

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

string (FieldMask format)

Obbligatorio. Una maschera di campo per limitare i campi di ogni persona restituiti. Puoi 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
  • professioni
  • organizzazioni
  • phoneNumbers
  • foto
  • relazioni
  • sipAddresses
  • grandi imprese
  • Url
  • userDefined
sources[]

enum (ReadSourceType)

(Facoltativo) Una maschera dei tipi di origine da restituire. Se non viene impostato, 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 relativa ai collegamenti 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 è connesso 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 dall'ultima richiesta. La richiesta deve impostare requestSyncToken per restituire il token di sincronizzazione. Quando la risposta è suddivisa in pagine, 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 viene richiesta la sincronizzazione.

Enum
LAST_MODIFIED_ASCENDING Ordinare le persone in base alla data di modifica; le voci meno recenti.
LAST_MODIFIED_DESCENDING Ordina le persone in base alla data di modifica, con le voci più recenti in primo piano.
FIRST_NAME_ASCENDING Ordina le persone per nome.
LAST_NAME_ASCENDING Ordina le persone per cognome.