Method: people.connections.list

Fournit la liste des contacts de l'utilisateur authentifié.

Les jetons de synchronisation expirent sept jours après la synchronisation complète. Lorsqu'une requête est envoyée avec un jeton de synchronisation arrivé à expiration, une erreur google.rpc.ErrorInfo est renvoyée pour la raison suivante : "EXPIRED_SYNC_TOKEN". Dans ce cas, les clients doivent effectuer une requête de synchronisation complète sans syncToken.

Un quota supplémentaire s'applique à la première page des demandes de synchronisation complète. Si le quota est dépassé, une erreur 429 s'affiche. Ce quota est fixe et ne peut pas être augmenté.

Lorsque le syncToken est spécifié, les ressources supprimées depuis la dernière synchronisation sont renvoyées en tant que personne avec PersonMetadata.deleted défini sur "true".

Lorsque pageToken ou syncToken est spécifié, tous les autres paramètres de requête doivent correspondre au premier appel.

Un délai de propagation de plusieurs minutes peut être nécessaire pour les opérations d'écriture pour les requêtes de synchronisation. Les synchronisations incrémentielles ne sont pas destinées aux cas d'utilisation de type lecture après écriture.

Pour voir un exemple d'utilisation, consultez Répertorier les contacts de l'utilisateur qui ont été modifiés.

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
(deprecated)

string

Obligatoire. Nom de la ressource pour laquelle renvoyer des connexions. Seul people/me est valide.

Paramètres de requête

Paramètres
pageToken

string

Facultatif. Un jeton de page, reçu à partir d'une réponse précédente nextPageToken. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à people.connections.list doivent correspondre au premier appel ayant fourni le jeton de page.
pageSize

integer

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

enum (SortOrder)

Facultatif. Ordre dans lequel les connexions doivent être triées. La valeur par défaut est LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

Facultatif. Indique si la réponse doit renvoyer nextSyncToken sur la dernière page de résultats. Il peut être utilisé pour obtenir des modifications incrémentielles depuis la dernière requête en le définissant sur la requête syncToken.

Pour en savoir plus sur le comportement de synchronisation, consultez people.connections.list.
syncToken

string

Facultatif. Un jeton de synchronisation, reçu à partir d'une réponse précédente nextSyncToken. Fournissez-le pour ne récupérer que les ressources modifiées depuis la dernière requête.

Lors de la synchronisation, tous les autres paramètres fournis à people.connections.list doivent correspondre au premier appel ayant fourni le jeton de synchronisation.

Pour en savoir plus sur le comportement de synchronisation, consultez people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Facultatif. OBSOLÈTE (Veuillez utiliser personFields à la place)

Masque permettant de limiter les résultats à un sous-ensemble de champs de personne.
personFields

string (FieldMask format)

Obligatoire. Masque de champ permettant de limiter les champs renvoyés pour chaque personne. Vous pouvez spécifier plusieurs champs en les séparant par une virgule. Les valeurs possibles sont les suivantes :

  • addresses
  • ageRanges
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • événements
  • externalIds
  • critères de sexe
  • imClients
  • centres d'intérêt
  • locales
  • emplacement
  • aux chaînes
  • métadonnées
  • miscKeywords
  • names
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Facultatif. Masque les types de sources à renvoyer. La valeur par défaut est READ_SOURCE_TYPE_CONTACT, et READ_SOURCE_TYPE_PROFILE si ce n'est pas le cas.

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 (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Champs
connections[]

object (Person)

Liste des personnes avec lesquelles le demandeur est connecté.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.
nextSyncToken

string

Un jeton, qui peut être envoyé en tant que syncToken pour récupérer les modifications apportées depuis la dernière requête. La requête doit définir requestSyncToken pour renvoyer le jeton de synchronisation. Lorsque la réponse est paginée, seule la dernière page contient nextSyncToken.
totalPeople
(deprecated)

integer

OBSOLÈTE (Veuillez utiliser totalItems) Nombre total d'utilisateurs dans la liste sans pagination.
totalItems

integer

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. Il n'est utilisé que si la synchronisation n'est pas demandée.

Enums
LAST_MODIFIED_ASCENDING Triez les personnes par date de modification, en commençant par les entrées les plus anciennes.
LAST_MODIFIED_DESCENDING Triez les personnes par date de modification ; les entrées les plus récentes apparaissent en premier.
FIRST_NAME_ASCENDING Triez les personnes par prénom.
LAST_NAME_ASCENDING Triez les personnes par nom.