- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- SortOrder
- Essayer
Fournit la liste des contacts de l'utilisateur authentifié.
Les jetons de synchronisation expirent sept jours après la synchronisation complète. Une requête avec un jeton de synchronisation arrivé à expiration générera une erreur avec un message d'erreur google.rpc.ErrorInfo avec la raison "EXPIRED_SYNC_TOKEN". En cas d'erreur de ce type, les clients doivent envoyer une requête de synchronisation complète sans
.syncToken
La première page d'une demande de synchronisation complète est soumise à un quota supplémentaire. Si le quota est dépassé, une erreur 429 est renvoyée. Ce quota est fixe et ne peut pas être augmenté.
Lorsque
est spécifié, les ressources supprimées depuis la dernière synchronisation sont renvoyées en tant que personne avec syncToken
défini sur "true".PersonMetadata.deleted
Lorsque
ou pageToken
est spécifié, tous les autres paramètres de requête doivent correspondre au premier appel.syncToken
Un délai de propagation de plusieurs minutes peut être nécessaire pour les requêtes de synchronisation en écriture. Les synchronisations incrémentielles ne sont pas destinées aux cas d'utilisation de lecture après écriture.
Pour voir un exemple d'utilisation, consultez Lister les contacts de l'utilisateur qui ont changé.
Requête HTTP
GET https://people.googleapis.com/v1/{resourceName=people/*}/connections
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
resourceName |
Obligatoire. Nom de la ressource pour laquelle renvoyer des connexions. Seul |
Paramètres de requête
Paramètres | |
---|---|
pageToken |
Facultatif. Jeton de page reçu d'une réponse Lors de la pagination, tous les autres paramètres fournis à |
pageSize |
Facultatif. Nombre de connexions à inclure dans la réponse. Les valeurs valides sont comprises entre 1 et 1 000 inclus. La valeur par défaut est 100 si elle n'est pas définie ou si elle est définie sur 0. |
sortOrder |
Facultatif. Ordre dans lequel les connexions doivent être triées. La valeur par défaut est |
requestSyncToken |
Facultatif. Indique si la réponse doit renvoyer Pour en savoir plus sur le comportement de synchronisation, consultez la page |
syncToken |
Facultatif. Jeton de synchronisation reçu d'une réponse Lors de la synchronisation, tous les autres paramètres fournis à Pour en savoir plus sur le comportement de synchronisation, consultez |
requestMask |
Facultatif. OBSOLÈTE (veuillez utiliser Masque permettant de limiter les résultats à un sous-ensemble de champs de personne. |
personFields |
Obligatoire. Masque de champ permettant de restreindre les champs de chaque personne renvoyés. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. Les valeurs valides sont les suivantes :
|
sources[] |
Facultatif. Masque des types de sources à renvoyer. Si ce champ n'est pas défini, la valeur par défaut est |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse à une requête pour les connexions de l'utilisateur authentifié.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{
"connections": [
{
object ( |
Champs | |
---|---|
connections[] |
Liste des personnes auxquelles le demandeur est mis en relation. |
nextPageToken |
Jeton pouvant être envoyé en tant que |
nextSyncToken |
Un jeton, qui peut être envoyé en tant que |
totalPeople |
OBSOLÈTE (veuillez utiliser "totalItems") Nombre total de personnes dans la liste sans pagination. |
totalItems |
Nombre total d'éléments dans la liste sans pagination. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
Pour en savoir plus, consultez le Guide relatif aux autorisations.
SortOrder
Ordre dans lequel une liste de connexions doit être triée. Cette valeur n'est utilisée que si la synchronisation n'est pas demandée.
Enums | |
---|---|
LAST_MODIFIED_ASCENDING |
Triez les personnes par date de modification ; les entrées plus anciennes en premier. |
LAST_MODIFIED_DESCENDING |
Triez les personnes par date de modification ; les entrées plus récentes en premier. |
FIRST_NAME_ASCENDING |
Triez les personnes par prénom. |
LAST_NAME_ASCENDING |
Triez les personnes par nom de famille. |