Method: otherContacts.list

Enumera todos los "Otros contactos", es decir, los contactos que no están en un grupo de contactos. Los "Otros contactos" suelen ser contactos creados 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 recibirá un error con un error google.rpc.ErrorInfo con el motivo "EXPIRED_SYNC_TOKEN". En el caso de 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 el syncToken, los recursos borrados desde la última sincronización se mostrarán como una persona con PersonMetadata.deleted establecido 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 un retraso de propagación de varios minutos en las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos de uso de lectura después de 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 se utiliza 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. Es la cantidad de "Otros contactos" que se incluirán en la respuesta. Los valores válidos se encuentran entre 1 y 1,000, inclusive. El valor predeterminado es 100 si no se configura 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 la 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 se modificaron 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 la sincronización en otherContacts.list.
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. Los valores válidos dependen del ReadSourceType que se use.

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

  • emailAddresses
  • metadatos
  • names
  • phoneNumbers
  • fotos

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

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

Los valores posibles para este campo son los siguientes:

No se permite 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

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

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

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 Person. Los “Otros contactos” admiten 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 los cambios desde la última solicitud. La solicitud debe configurar requestSyncToken para mostrar el token de sincronización.
totalSize

integer

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

Permisos de 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.