Method: people.searchContacts

Fornece uma lista de contatos nos contatos agrupados do usuário autenticado que corresponde à consulta de pesquisa. A consulta corresponde aos campos names, nickNames, emailAddresses, phoneNumbers e organizations de um contato que são da origem CONTACT.

IMPORTANTE: antes da pesquisa, os clientes devem enviar uma solicitação de aquecimento com uma consulta vazia para atualizar o cache. Consulte https://developers.google.com/people/v1/contacts#search_the_users_contacts.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
query

string

Obrigatório. A consulta de texto simples para a solicitação. A consulta é usada para corresponder frases de prefixo dos campos em uma pessoa. Por exemplo, uma pessoa com o nome "foo name" corresponde a consultas como "f", "fo", "foo", "foo n", "nam" etc., mas não a "oo n".
pageSize

integer

Opcional. O número de resultados a serem retornados. O padrão será 10 se o campo não estiver definido ou será definido como 0. Valores superiores a 30 serão limitados a 30.
readMask

string (FieldMask format)

Obrigatório. Uma máscara de campo para restringir quais campos de cada pessoa são retornados. É possível especificar vários campos separados por vírgulas. Os valores válidos são:

  • addresses
  • ageRanges
  • biografias
  • aniversários
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • events
  • externalIds
  • sexos
  • imClients
  • interesses
  • locales
  • locais
  • dos canais
  • metadados
  • miscKeywords
  • names
  • apelidos
  • ocupações
  • organizations
  • phoneNumbers
  • fotos
  • relações
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Uma máscara dos tipos de origem a serem retornados. Se não for definido, o padrão será READ_SOURCE_TYPE_CONTACT.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de SearchResponse.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para mais informações, consulte o Guia de autorização.