Method: otherContacts.list

Afficher tous les "Autres contacts", c'est-à-dire les contacts qui n'appartiennent pas à un groupe de contacts "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. 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". Dans ce cas, 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 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 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 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. Jeton de page, reçu 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. Le nombre de "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 configurée 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 la page otherContacts.list.
syncToken

string

Facultatif. Jeton de synchronisation reçu d'une réponse précédente nextSyncToken Fournissez ce paramètre pour récupérer uniquement 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 la page 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 du type ReadSourceType utilisé.

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

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

Si READ_SOURCE_TYPE_PROFILE est utilisé, 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
  • zones géographiques
  • aux chaînes
  • métadonnées
  • miscKeywords
  • noms
  • surnoms
  • professions
  • organizations
  • phoneNumbers
  • photos
  • relations
  • sipAddresses
  • skills
  • URL
  • userDefined
sources[]

enum (ReadSourceType)

Facultatif. Masque des types de sources à renvoyer. Si ce champ n'est pas défini, la valeur par défaut est READ_SOURCE_TYPE_CONTACT.

Les valeurs possibles pour 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 pour 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)

La liste "Autres contacts" renvoyées en tant que ressources "Person". "Autres contacts" n'acceptent qu'un sous-ensemble limité de champs. Pour en savoir plus, consultez 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 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 dans 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.