- Solicitud HTTP
- Parámetros de ruta de acceso
- Parámetros de consulta
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- SortOrder
- Pruébala
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 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
, los recursos borrados desde la última sincronización se mostrarán como una persona con syncToken
establecido como verdadero.PersonMetadata.deleted
Cuando se especifica
o pageToken
, todos los demás parámetros de solicitud deben coincidir con la primera llamada.syncToken
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 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 |
Obligatorio. El nombre del recurso para el que se mostrarán las conexiones. Solo es válido |
Parámetros de consulta
Parámetros | |
---|---|
pageToken |
Opcional. Un token de página, recibido de un Cuando se utiliza la paginación, todos los demás parámetros proporcionados a |
pageSize |
Opcional. La cantidad de conexiones 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. |
sortOrder |
Opcional. El orden en el que deben ordenarse las conexiones. La configuración predeterminada es |
requestSyncToken |
Opcional. Indica si la respuesta debe mostrar Obtén más información sobre el comportamiento de la sincronización en |
syncToken |
Opcional. Un token de sincronización recibido de una respuesta anterior Durante la sincronización, todos los demás parámetros proporcionados a Obtén más información sobre el comportamiento de la sincronización en |
requestMask |
Opcional. OBSOLETO (en su lugar, usa Una máscara para restringir los resultados a un subconjunto de campos de persona. |
personFields |
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:
|
sources[] |
Opcional. Una máscara de los tipos de fuentes que se mostrarán. La configuración predeterminada es |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Es la respuesta a una solicitud para las conexiones del usuario autenticado.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{
"connections": [
{
object ( |
Campos | |
---|---|
connections[] |
Es la lista de personas con las que está conectado el solicitante. |
nextPageToken |
Un token, que se puede enviar como |
nextSyncToken |
Un token, que se puede enviar como |
totalPeople |
OBSOLETO (Usa totalItems) El número total de personas de la lista sin paginación. |
totalItems |
La cantidad total de elementos de la lista sin paginación. |
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.
SortOrder
Es 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 la fecha de cambio; primero, las entradas más antiguas. |
LAST_MODIFIED_DESCENDING |
Ordena a las personas según la fecha en que se modificaron; primero, especifica las entradas más recientes. |
FIRST_NAME_ASCENDING |
Ordena a las personas por nombre. |
LAST_NAME_ASCENDING |
Ordena a las personas por apellido. |