Method: people.connections.list

Fournit une 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 affichera une erreur avec un message google.rpc.ErrorInfo avec le motif "EXPIRED_SYNC_TOKEN". Dans ce cas, les clients doivent effectuer une requête de synchronisation complète sans syncToken.

La première page d'une requête de synchronisation complète comporte 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 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.

Les requêtes d'écriture peuvent avoir un délai de propagation de plusieurs minutes pour les requêtes de synchronisation. Les synchronisations incrémentielles ne sont pas destinées aux cas d'utilisation en 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 ressource pour lequel renvoyer des connexions. Seul people/me est valide.

Paramètres de requête

Paramètres
pageToken

string

Facultatif. Jeton de page, reçu d'une réponse nextPageToken précédente. 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 configurée 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 afficher nextSyncToken sur la dernière page de résultats. Vous pouvez l'utiliser pour obtenir des modifications incrémentielles depuis la dernière requête en la définissant sur la requête syncToken.

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

syncToken

string

Facultatif. Jeton de synchronisation, reçu d'une réponse précédente nextSyncToken Fournissez ce jeton 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 la 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
  • tranches d'âge
  • biographies
  • anniversaires
  • calendarUrls
  • clientData
  • photosdecouverture
  • emailAddresses
  • événements
  • ID externes
  • critères de sexe
  • ImClients
  • centres d'intérêt
  • locales
  • zones géographiques
  • aux chaînes
  • metadata
  • Divers mots clés
  • names
  • pseudonymes
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • SipAddresses
  • skills
  • URL
  • défini par l'utilisateur
sources[]

enum (ReadSourceType)

Facultatif. Masque des types de sources à renvoyer. Si ce n'est pas le cas, les valeurs par défaut sont READ_SOURCE_TYPE_CONTACT et READ_SOURCE_TYPE_PROFILE.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Réponse à une requête pour les connexions de l'utilisateur authentifié.

Représentation JSON
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Champs
connections[]

object (Person)

Liste des personnes auxquelles 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 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

DEPRECATED (Veuillez utiliser totalItems) Nombre total de personnes 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. Cette option n'est utilisée que si la synchronisation n'est pas demandée.

Enums
LAST_MODIFIED_ASCENDING Trier les utilisateurs par date de modification (les entrées les plus anciennes en premier)
LAST_MODIFIED_DESCENDING Trier les utilisateurs par date de modification (les entrées les plus récentes en premier)
FIRST_NAME_ASCENDING Trier les personnes par prénom.
LAST_NAME_ASCENDING Trier les personnes par nom.