Method: otherContacts.list

Elenca tutti gli "Altri contatti", ovvero i contatti che non fanno parte di un gruppo. Gli "Altri contatti" sono in genere contatti creati automaticamente dalle interazioni.

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 gli altri contatti dell'utente che sono cambiati.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

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

integer

Campo facoltativo. Il numero di "Altri contatti" 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.
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 otherContacts.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 otherContacts.list devono corrispondere alla prima chiamata che ha fornito il token di sincronizzazione.

Ulteriori dettagli sul comportamento di sincronizzazione sono disponibili all'indirizzo otherContacts.list.
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 dipendono dal tipo di ReadSourceType utilizzato.

Se viene utilizzato READ_SOURCE_TYPE_CONTACT, i valori validi sono:

  • emailAddresses
  • metadati
  • names
  • phoneNumbers
  • foto

Se viene utilizzato READ_SOURCE_TYPE_PROFILE, 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 impostato, il valore predefinito è READ_SOURCE_TYPE_CONTACT.

I valori possibili per questo campo sono:

Non è consentito specificare READ_SOURCE_TYPE_PROFILE senza specificare READ_SOURCE_TYPE_CONTACT.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

La risposta a una richiesta relativa agli "Altri contatti " dell'utente autenticato.

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

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

object (Person)

L'elenco di "Altri contatti" restituito come risorse Persona. "Altri contatti" supporta un sottoinsieme limitato di campi. Per informazioni più dettagliate, consulta ListOtherContactsRequest.request_mask.
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.
totalSize

integer

Il numero totale di altri contatti nell'elenco senza impaginazione.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la guida all'autorizzazione.