Method: otherContacts.list

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

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 questo caso, 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 il valore 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 a casi d'uso di lettura dopo scrittura.

Consulta un esempio di utilizzo in Elencare 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 query

Parametri
pageToken

string

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

integer

(Facoltativo) Il numero di "Altri contatti" 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.
requestSyncToken

boolean

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

Ulteriori dettagli sul comportamento di sincronizzazione all'indirizzo otherContacts.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 otherContacts.list devono corrispondere alla prima chiamata che ha fornito il token di sincronizzazione.

Ulteriori dettagli sul comportamento di sincronizzazione all'indirizzo otherContacts.list.
readMask

string (FieldMask format)

Obbligatorio. Una maschera di campo per limitare i campi restituiti per ogni persona. Puoi specificare più campi separandoli con virgole. I valori validi dipendono dal valore ReadSourceType utilizzato.

Se viene utilizzato READ_SOURCE_TYPE_CONTACT, i valori validi sono:

  • emailAddresses
  • metadati
  • nomi
  • phoneNumbers
  • foto

Se viene utilizzato READ_SOURCE_TYPE_PROFILE, 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 (ReadSourceType)

(Facoltativo) Una maschera dei tipi di origine da restituire. Se non è configurato, 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 di "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 "Altri contatti" restituite come risorse Persona. "Altri contatti" supporta un sottoinsieme limitato di campi. Per informazioni più dettagliate, vedi 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 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.