- Requête HTTP
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
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
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 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 |
Facultatif. Jeton de page, reçu d'une réponse précédente Lors de la pagination, tous les autres paramètres fournis à |
pageSize |
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 |
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 précédente Lors de la synchronisation, tous les autres paramètres fournis à Pour en savoir plus sur le comportement de synchronisation, consultez la page |
readMask |
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:
Si READ_SOURCE_TYPE_PROFILE est utilisé, 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 Les valeurs possibles pour ce champ sont les suivantes: Il n'est pas possible de spécifier |
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 ( |
Champs | |
---|---|
otherContacts[] |
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 |
Jeton pouvant être envoyé en tant que |
nextSyncToken |
Un jeton, qui peut être envoyé en tant que |
totalSize |
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.