Method: people.connections.list

Proporciona una lista de los contactos del usuario autenticado.

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 google.rpc.ErrorInfo con el motivo "EXPIRED_SYNC_TOKEN". En caso de que se produzca un error de este tipo, 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 excede la cuota, se mostrará un error 429. Esta cuota es fija y no se puede aumentar.

Cuando se especifica 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 una demora de propagación de varios minutos para las solicitudes de sincronización. Las sincronizaciones incrementales no están diseñadas para casos de uso de lectura después de la escritura.

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

Solicitud HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

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

Parámetros de ruta de acceso

Parámetros
resourceName
(deprecated)

string

Obligatorio. Es el nombre del recurso para el que se mostrarán las conexiones. Solo el people/me es válido.

Parámetros de consulta

Parámetros
pageToken

string

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

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

integer

Opcional. La cantidad de conexiones que se incluirán en la respuesta. Los valores válidos deben estar entre 1 y 1,000, inclusive. Si no se establece o se establece en 0, el valor predeterminado es 100.
sortOrder

enum (SortOrder)

Opcional. El orden en el que se deben ordenar las conexiones. La configuración predeterminada es LAST_MODIFIED_ASCENDING.
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 configurándola en la solicitud syncToken.

Obtén más detalles sobre el comportamiento de sincronización en people.connections.list.
syncToken

string

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

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

Obtén más detalles sobre el comportamiento de sincronización en people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Opcional. OBSOLETO (en su lugar, usa personFields).

Una máscara para restringir los resultados a un subconjunto de campos de personas.
personFields

string (FieldMask format)

Obligatorio. Es una máscara de campo para restringir qué campos de cada persona se muestran. Se pueden especificar varios campos separándolos con comas. Estos son los valores válidos:

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

enum (ReadSourceType)

Opcional. Es una máscara de los tipos de fuentes que se mostrarán. Si no se configura, el valor predeterminado es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

La respuesta a una solicitud de conexiones del usuario autenticado.

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

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

object (Person)

La lista de personas con las que el solicitante está conectado.
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 establecer requestSyncToken para mostrar el token de sincronización. Cuando la respuesta esté paginada, solo la última página contendrá nextSyncToken.
totalPeople
(deprecated)

integer

OBSOLETO (Usa totalItems) La cantidad total de personas en la lista sin paginación.
totalItems

integer

Es la cantidad total de elementos de la lista sin paginación.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.

SortOrder

Es el orden en el que se debe ordenar una lista de conexiones. Solo se usa si no se solicita la sincronización.

Enumeraciones
LAST_MODIFIED_ASCENDING Ordena a las personas por la fecha en que se modificaron, las más antiguas primero.
LAST_MODIFIED_DESCENDING Ordenar las personas según la fecha de modificación las entradas más recientes primero.
FIRST_NAME_ASCENDING Ordena a las personas por nombre.
LAST_NAME_ASCENDING Ordena a las personas por apellido.