Method: people.searchContacts

Fornisce un elenco dei contatti raggruppati dell'utente autenticato che corrispondono alla query di ricerca. La query corrisponde ai campi names, nickNames, emailAddresses, phoneNumbers e organizations di un contatto provenienti dall'origine CONTACT.

IMPORTANTE: prima di cercare, i client devono inviare una richiesta di riscaldamento con una query vuota per aggiornare la cache. Visita la pagina https://developers.google.com/people/v1/contacts#search_the_users_contacts

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di ricerca

Parametri
query

string

obbligatorio. La query in testo normale per la richiesta. La query viene utilizzata per trovare corrispondenze tra le frasi di prefisso dei campi di una persona. Ad esempio, una persona con il nome "nome foo" corrisponde a query come "f", "fo", "foo", "foo n", "nam" ecc., ma non "oo n".
pageSize

integer

Campo facoltativo. Il numero di risultati da restituire. Il valore predefinito è 10 se il campo non è impostato oppure viene impostato su 0. I valori superiori a 30 verranno limitati a 30.
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:

  • 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.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di SearchResponse.

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.