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 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 contactos del usuario que han cambiado.

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. El nombre del recurso para el que se muestran las conexiones. Solo es válido people/me.

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 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 deben 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.
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 si la configuras en la solicitud syncToken.

Obtén más información 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 esto para recuperar solo los recursos que cambiaron 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 información 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. Una máscara de campo que restringe los campos que se muestran en cada persona. Se pueden especificar varios campos separándolos con comas. A continuación, se indican los valores válidos:

  • 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 La configuración predeterminada es READ_SOURCE_TYPE_CONTACT y READ_SOURCE_TYPE_PROFILE si no se configura.

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 conexión del usuario autenticado.

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

object (Person)

La lista de personas a las que está conectado el solicitante.
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. Cuando se pagina la respuesta, solo la última página contendrá nextSyncToken.
totalPeople
(deprecated)

integer

OBSOLETO (use totalItems) (la cantidad total de personas en la lista sin paginación)
totalItems

integer

La cantidad total de elementos de la lista sin paginación

Alcances de la 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.

SortOrder

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

Enumeradores
LAST_MODIFIED_ASCENDING Ordena a las personas según el momento en que se modificaron. Primero ingresa las entradas más antiguas.
LAST_MODIFIED_DESCENDING Ordena a las personas según el momento en que se cambiaron. Primero, ingresa la información más reciente.
FIRST_NAME_ASCENDING Ordenar personas por nombre.
LAST_NAME_ASCENDING Ordenar personas por apellido.