L'API Contacts a été désactivée le 19 janvier 2022. Consultez ce guide pour en savoir plus sur les modifications apportées aux champs, aux points de terminaison et aux champs d'application d'autorisation lors de la migration vers l'API People.
Présentation
L'API People présente les mêmes fonctionnalités que l'ancienne API Contacts pour toutes les fonctionnalités, à l'exception des cas suivants pour Autres contacts:
Les administrateurs disposent d'autorisations en lecture seule pour "Autres contacts" via le nouveau champ d'application. Comme il n'est pas possible de renvoyer des signaux de modification/écriture à "Autres contacts", vos utilisateurs devront ajouter l'autre contact dans "Mon contact" s'ils souhaitent mettre à jour ses champs de données.
Seules les coordonnées de base des "Autres contacts" peuvent être lues via l'API. Par exemple, nom complet, adresse e-mail et numéro de téléphone.
De plus, l'ancien champ d'application Contacts (https://www.google.com/m8/feeds), qui permettait d'accéder à la fois aux contacts personnels et aux informations de l'annuaire, est remplacé par les champs d'application suivants:
- Pour accéder aux contacts personnels:
https://www.googleapis.com/auth/contacts - Pour accéder aux informations de l'annuaire:
https://www.googleapis.com/auth/directory.readonly
Contacts
Mappage des champs
| Champ de contact | Champ de personnes |
|---|---|
| atom:content | biographies |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | photos |
| atom:title | names |
| gContact:informationfacturation | miscMots clés (type=OUTLOOK_BILLING_INFORMATION) |
| gContact:anniversaire | anniversaires |
| gContact:lien-agenda | calendarUrls |
| gContact:DirectoryServer | misckeywords (type=OUTLOOK_DIRECTORY_SERVER) |
| gContact:événement | événements |
| gContact:extendedProperty | clientData |
| gContact:IDexterne | externalIds |
| gContact:fileAs | fileAses |
| gContact:sexe | genres |
| gContact:groupMembershipInfo | memberships.contactGroupMembership |
| gContact:hobby | centres d'intérêt |
| gContact:initiales | Pseudo OBSOLÈTE (type=INITIALS) |
| gContact:jot type='home' | DiversMots clés (type=HOME) |
| gContact:jot type='keywords' | DiversMots clés (type=OUTLOOK_KEYWORD) |
| gContact:jot type='autre' | DiversMots clés (type=OTHER) |
| gContact:jot type='utilisateur' | DiversMots clés (type=OUTLOOK_USER) |
| gContact:jot type='travail' | DiversMots clés (type=TRAVAIL) |
| gContact:langue | langues |
| gContact:maidenName | Pseudo OBSOLÈTE (type=MAIDEN_NAME) |
| gContact:kilométrage | miscMots clés (type=OUTLOOK_MILEAGE) |
| gContact:pseudo | pseudonymes (type=PAR DÉFAUT) |
| gContact:profession | professionnels |
| gContact:priorité | DiversMots clés (type=OUTLOOK_PRIORITY) |
| gContact:relation | Relations |
| gContact:sensibilité | DiversMots clés (type=OUTLOOK_SENSITIVITY) |
| gContact:nom_court | Pseudo OBSOLÈTE (type=SHORT_NAME) |
| gContact:objet | DiversMots clés (type=OUTLOOK_SUBJECT) |
| gContact:userDefinedField | userDefined |
| gContact:site Web | urls |
| gContact:yomiName | names.phonetic_full_name |
| gd:supprimé | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:organisation | organizations |
| gd:phoneNumber | phoneNumbers |
| gd:postalAddress | addresses.formattedValue |
| gd:où | résidences |
| gd:structuredPostalAddress | adresses |
Points de terminaison des contacts personnels
Read
Nécessite le niveau d'accès https://www.googleapis.com/auth/contacts ou https://www.googleapis.com/auth/contacts.readonly.
- Lire un seul contact spécifique
people.get - Lire plusieurs contacts spécifiques
people.getBatchGet - Lire les contacts avec
people.connections.list
Modification
Nécessite un niveau d'accès https://www.googleapis.com/auth/contacts. Modifie tous les champs de contact, à l'exception des photos.
- Créer un contact avec
people.createContact - Mettre à jour un contact existant à l'aide de
people.updateContact - Supprimez un contact à l'aide de
people.deleteContact.
Modification de la photo
Nécessite un niveau d'accès https://www.googleapis.com/auth/contacts.
- Modifiez la photo d'un contact à l'aide de
people.updateContactPhoto. - Supprimez une photo de contact à l'aide de
people.deleteContactPhoto.
Autres points de terminaison de Contacts
Read
Les autres contacts sont en lecture seule, et seuls les champs names, emailAddresses et phoneNumbers sont renvoyés.
Nécessite un niveau d'accès https://www.googleapis.com/auth/contacts.other.readonly.
- Consultez d'autres contacts avec
otherContacts.list.
Copiez
Nécessite les champs d'application https://www.googleapis.com/auth/contacts.other.readonly et https://www.googleapis.com/auth/contacts.
- Copier d'autres contacts en utilisant
otherContacts.copyOtherContactToMyContactsGroup
Points de terminaison de la liste d'adresses globale
Nécessite un niveau d'accès https://www.googleapis.com/auth/directory.readonly.
- Répertorier tous les contacts et profils de l'annuaire
people.listDirectoryPeople - Rechercher dans les contacts et les profils de l'annuaire
people.searchDirectoryPeople
Groupes de contacts
Mappage des champs
| Champ de groupe de contacts de l'API Contacts | Champ de groupe de contacts de l'API People |
|---|---|
| atom:mise à jour | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:supprimé | metadata.deleted |
| systemGroup | groupType=GROUPE_CONTACT_SYSTÈME |
Points de terminaison
Read
Nécessite le niveau d'accès https://www.googleapis.com/auth/contacts ou https://www.googleapis.com/auth/contacts.readonly.
- Obtenir un groupe de contacts spécifique à l'aide de
people.contactGroups.get - Répertorier les groupes de contacts à l'aide de
people.contactGroups.list
Modification
Nécessite un niveau d'accès https://www.googleapis.com/auth/contacts.
- Créer un groupe de contacts avec
people.contactGroups.create - Mettre à jour un groupe de contacts à l'aide de
people.contactGroups.update - Supprimer un groupe de contacts avec
people.contactGroups.delete Ajouter ou supprimer des contacts dans le groupe de contacts à l'aide de
people.contactGroups.members.modify
Champs d'application des autorisations
L'ancien champ d'application https://www.google.com/m8/feeds est un alias du champ d'application https://www.googleapis.com/auth/contacts. Cela signifie que les autorisations OAuth existantes avec l'ancien champ d'application fonctionneront pour tous les points de terminaison de l'API People qui nécessitent le champ d'application https://www.googleapis.com/auth/contacts. L'accès en lecture et en écriture aux contacts et groupes de contacts fonctionne avec l'ancien champ d'application.
L'API People a besoin de nouveaux niveaux d'accès pour accéder aux "Autres contacts" ou aux données d'annuaire. Reportez-vous aux informations ci-dessus pour connaître les niveaux d'accès requis.
Pour en savoir plus, consultez la page Autoriser les requêtes.
Bibliothèques clientes
- Pour Apps Script, consultez l'article Service avancé des personnes.
- Pour les autres langages compatibles, consultez Installer des bibliothèques clientes.