Method: otherContacts.list

Enumera todos los "Otros contactos", es decir, aquellos que no están en un grupo de contactos. Por lo general, los "Otros contactos" son contactos que se crean automáticamente a partir de las interacciones.

Los tokens de sincronización vencen 7 días después de la sincronización completa. Una solicitud con un token de sincronización vencido obtendrá un error con un google.rpc.ErrorInfo por el motivo "EXPIRED_SYNC_TOKEN". En caso de que se produzca este error, los clientes deben realizar una solicitud de sincronización completa sin un syncToken.

La primera página de una solicitud de sincronización completa tiene una cuota adicional. Si se supera la cuota, se mostrará un error 429. Esta cuota es fija y no se puede aumentar.

Cuando se especifica la syncToken, los recursos borrados desde la última sincronización se mostrarán como una persona con PersonMetadata.deleted configurado como verdadero.

Cuando se especifica pageToken o syncToken, todos los demás parámetros de solicitud deben coincidir con la primera llamada.

Las operaciones de escritura pueden tener una demora de propagación de varios minutos para las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos prácticos de lectura y escritura.

Consulta un ejemplo de uso en Enumera los otros contactos del usuario que cambiaron.

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
pageToken

string

Opcional. Un token de página, recibido de un nextPageToken de respuesta anterior. Proporciona esto para recuperar la página siguiente.

Cuando realices la paginación, todos los demás parámetros proporcionados a otherContacts.list deben coincidir con la primera llamada que proporcionó el token de la página.
pageSize

integer

Opcional. Número de "Otros contactos" que se incluirá en la respuesta. Los valores válidos deben estar entre 1 y 1,000, inclusive. El valor predeterminado es 100 si no se establece o se establece en 0.
requestSyncToken

boolean

Opcional. Indica si la respuesta debe mostrar nextSyncToken en la última página de resultados. Se puede usar para obtener cambios incrementales desde la última solicitud si la configuras en la solicitud syncToken.

Obtén más información sobre el comportamiento de sincronización en otherContacts.list.
syncToken

string

Opcional. Un token de sincronización, recibido de una respuesta anterior nextSyncToken Proporciona esto para recuperar solo los recursos que cambiaron desde la última solicitud.

Durante la sincronización, todos los demás parámetros proporcionados a otherContacts.list deben coincidir con la primera llamada que proporcionó el token de sincronización.

Obtén más información sobre el comportamiento de sincronización en otherContacts.list.
readMask

string (FieldMask format)

Obligatorio. Una máscara de campo que restringe los campos que se muestran en cada persona. Se pueden especificar varios campos separándolos con comas. Los valores válidos dependen de lo que se usa en ReadSourceType.

Si se usa READ_SOURCE_TYPE_CONTACT, los valores válidos son los siguientes:

  • Direcciones de correo electrónico
  • metadata
  • names
  • númerosdeteléfono
  • fotos

Si se usa READ_SOURCE_TYPE_PROFILE, los valores válidos son los siguientes:

  • addresses
  • Rangos de edad
  • biografías
  • cumpleaños
  • URL de calendario
  • datosdelcliente
  • fotos de portada
  • Direcciones de correo electrónico
  • eventos
  • ID externos
  • Sexos
  • clientes potenciales
  • Intereses
  • locales
  • ubicaciones
  • memberships
  • metadata
  • palabras clave varias
  • names
  • sobrenombres
  • profesiones
  • organizations
  • númerosdeteléfono
  • fotos
  • relaciones
  • direccionessip
  • skills
  • url
  • definido por el usuario
sources[]

enum (ReadSourceType)

Opcional. Una máscara de los tipos de fuentes que se mostrarán Si no se establece, la configuración predeterminada es READ_SOURCE_TYPE_CONTACT.

Los valores posibles para este campo son los siguientes:

No se puede especificar READ_SOURCE_TYPE_PROFILE sin especificar READ_SOURCE_TYPE_CONTACT.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Es la respuesta a una solicitud de "Otros contactos" del usuario autenticado.

Representación JSON 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Campos
otherContacts[]

object (Person)

La lista de "Otros contactos" que se muestra como Recursos de persona. La opción "Otros contactos" admite un subconjunto limitado de campos. Consulta ListOtherContactsRequest.request_mask para obtener información más detallada.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.
nextSyncToken

string

Un token, que se puede enviar como syncToken para recuperar cambios desde la última solicitud. La solicitud debe configurar requestSyncToken para que muestre el token de sincronización.
totalSize

integer

La cantidad total de otros contactos de la lista sin paginación.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

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