Method: otherContacts.list

Répertoriez tous les "Autres contacts", c'est-à-dire les contacts qui ne font pas partie d'un groupe de contacts. Les "autres contacts" sont généralement des contacts créés automatiquement à partir d'interactions.

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 autres contacts de l'utilisateur qui ont été modifiés.

Requête HTTP

GET https://people.googleapis.com/v1/otherContacts

L'URL utilise la syntaxe de transcodage gRPC.

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 à otherContacts.list doivent correspondre au premier appel ayant fourni le jeton de page.
pageSize

integer

Facultatif. Nombre d'autres contacts à 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.
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 otherContacts.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 à otherContacts.list doivent correspondre au premier appel ayant fourni le jeton de synchronisation.

Pour en savoir plus sur le comportement de synchronisation, consultez otherContacts.list.
readMask

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 valides dépendent de l'élément ReadSourceType utilisé.

Si READ_SOURCE_TYPE_CONTACT est utilisé, les valeurs valides sont les suivantes:

  • emailAddresses
  • métadonnées
  • names
  • phoneNumbers
  • photos

Si vous utilisez READ_SOURCE_TYPE_PROFILE, les valeurs valides 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. Si ce champ n'est pas spécifié, la valeur par défaut est READ_SOURCE_TYPE_CONTACT.

Les valeurs possibles de ce champ sont les suivantes:

Il n'est pas possible de spécifier READ_SOURCE_TYPE_PROFILE sans spécifier READ_SOURCE_TYPE_CONTACT.

Corps de la requête

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

Corps de la réponse

Réponse à une requête concernant les "Autres contacts " 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 
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Champs
otherContacts[]

object (Person)

Liste "Autres contacts" affichée en tant que ressources de type "Personne". L'option "Autres contacts" n'accepte qu'un sous-ensemble limité de champs. Pour en savoir plus, consultez la page ListOtherContactsRequest.request_mask.
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.
totalSize

integer

Nombre total d'autres contacts de la liste, sans pagination

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/contacts.other.readonly

Pour en savoir plus, consultez le guide relatif aux autorisations.