Method: people.searchContacts

Proporciona una lista de contactos en los contactos agrupados del usuario autenticado que coincide con la búsqueda. La consulta coincide con los campos names, nickNames, emailAddresses, phoneNumbers y organizations de un contacto que son de la fuente CONTACT.

IMPORTANTE: Antes de realizar la búsqueda, los clientes deben enviar una solicitud de preparación con una consulta vacía para actualizar la caché. Consulta https://developers.google.com/people/v1/contacts#search_the_users_contacts

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de consulta

Parámetros
query

string

Obligatorio. Consulta de texto sin formato para la solicitud. La consulta se usa para hacer coincidir frases de prefijo de los campos de una persona. Por ejemplo, una persona con el nombre “foo name” coincide con consultas como “f”, “fo”, “foo”, “foo n”, “nam”, etc., pero no con “oo n”.
pageSize

integer

Opcional. La cantidad de resultados que se mostrarán. El valor predeterminado es 10 si el campo no está configurado, o bien se establece en 0. Los valores superiores a 30 se limitarán a 30.
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran de cada persona. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:

  • addresses
  • ageRanges
  • biografías
  • cumpleaños
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • eventos
  • externalIds
  • Sexos
  • imClients
  • Intereses
  • locales
  • de ubicaciones
  • memberships
  • metadatos
  • miscKeywords
  • names
  • sobrenombres
  • profesiones
  • organizations
  • phoneNumbers
  • fotos
  • relaciones
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opcional. Una máscara de los tipos de fuentes que se mostrarán. El valor predeterminado es READ_SOURCE_TYPE_CONTACT si no se configura.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de SearchResponse.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta la guía de autorización.