L'API Contacts è stata disattivata il 19 gennaio 2022. Utilizza questa guida per scoprire di più sulle modifiche a campi, endpoint e ambiti di autorizzazione durante la migrazione all'API People.
Panoramica
L'API People ha le stesse funzionalità dell'API Contacts precedente per tutte le funzionalità, con le seguenti eccezioni per Altri contatti:
Grazie al nuovo ambito, gli amministratori dispongono di autorizzazioni di sola lettura per "Altri contatti". Poiché l'invio di segnali di modifica/scrittura ad "Altri contatti" non è supportato, gli utenti dovranno aggiungere l'altro contatto come contatto personale se vogliono aggiornare i relativi campi dati.
Solo le informazioni di contatto di base per "Altri contatti" possono essere lette tramite l'API. Ad esempio, nome completo, indirizzo email e numero di telefono.
Inoltre, il vecchio ambito di Contatti (https://www.google.com/m8/feeds), che forniva l'accesso sia ai contatti personali che alle informazioni della directory, viene sostituito dai seguenti ambiti:
- Per accedere ai contatti personali:
https://www.googleapis.com/auth/contacts - Per accedere alle informazioni della directory:
https://www.googleapis.com/auth/directory.readonly
Contatti
Mappatura campi
| Campo contatto | Campo persona |
|---|---|
| atom:content | biografie |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | foto |
| atom:title | names |
| gContact:Datidifatturazione | miscParole chiave (type=OUTLOOK_BILLING_INFORMATION) |
| gContact:compleanno | compleanni |
| gContact:calendarLink | calendarUrls |
| gContact:serverdirectory | miscParole chiave (type=OUTLOOK_DIRECTORY_SERVER) |
| gContact:evento | eventi |
| gContact:extendedProperty | clientData |
| gContact:IDesterno | externalIds |
| gContact:fileA | fileAses |
| gContact:genere | gender [genere] |
| gContact:InformazioniDiAppartenenza | memberships.contactGroupMembership |
| gContact:hobby | interessi |
| gContact:iniziali | OBSOLETO nickname (type=INITIALS) |
| gContact:jot type='home' | VarieParole chiave (type=HOME) |
| gContact:jot type='keywords' | miscParole chiave (type=OUTLOOK_KEYWORD) |
| gContact:jot type='altro' | miscParole chiave (type=OTHER) |
| gContact:jot type='user' | miscParole chiave (type=OUTLOOK_USER) |
| gContact:jot type='lavoro' | VarieParole chiave (type=WORK) |
| gContact:lingua | lingue |
| gContact:nomemaiden | OBSOLETO nickname (type=MAIDEN_NAME) |
| gContact:chilometraggio | miscParole chiave (type=OUTLOOK_MILEAGE) |
| gContact:nickname | nickname (type=DEFAULT) |
| gContact:occupazione | occupazioni |
| gContact:priorità | miscParole chiave (type=OUTLOOK_PRIORITY) |
| gContact:relazione | relazioni |
| gContact:sensibilità | miscParole chiave (type=OUTLOOK_SENSITIVITY) |
| gContact:shortName | OBSOLETO nickname (type=SHORT_NAME) |
| gContact:oggetto | miscParole chiave (type=OUTLOOK_SUBJECT) |
| Campo gContact:userdefined | userDefined |
| gContact:sito web | urls |
| gContact:Nomeyomi | names.phonetic_full_name |
| gd:deleted | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:organizzazione | organizations |
| gd:phoneNumber | phoneNumbers |
| gd:postalAddress | addresses.formattedValue |
| gd:dove | residenze |
| gd:structuredPostalAddress | indirizzi |
Endpoint dei contatti personali
Letto
Richiede l'ambito https://www.googleapis.com/auth/contacts o https://www.googleapis.com/auth/contacts.readonly.
- Leggere un singolo contatto specifico
people.get - Leggere diversi contatti specifici
people.getBatchGet - Lettura dei contatti tramite
people.connections.list
Modifica
Richiede l'ambito https://www.googleapis.com/auth/contacts. Modifica tutti i campi di contatto tranne le foto.
- Crea un contatto utilizzando
people.createContact - Aggiorna un contatto esistente utilizzando
people.updateContact - Elimina un contatto
utilizzando
people.deleteContact.
Modifica foto
Richiede l'ambito https://www.googleapis.com/auth/contacts.
- Aggiorna una foto del contatto utilizzando
people.updateContactPhoto. - Elimina una foto del contatto utilizzando
people.deleteContactPhoto.
Altri endpoint contatti
Letto
Gli altri contatti sono di sola lettura e vengono restituiti solo i campi names, emailAddresses e phoneNumbers.
Richiede l'ambito https://www.googleapis.com/auth/contacts.other.readonly.
- Leggi altri contatti utilizzando
otherContacts.list.
Copia
Richiede gli ambiti https://www.googleapis.com/auth/contacts.other.readonly e https://www.googleapis.com/auth/contacts.
- Copia altri contatti utilizzando
otherContacts.copyOtherContactToMyContactsGroup.
Endpoint dell'elenco indirizzi globale
Richiede l'ambito https://www.googleapis.com/auth/directory.readonly.
- Elenca tutti i contatti e i profili della directory
people.listDirectoryPeople. - Cerca contatti e profili della directory
people.searchDirectoryPeople.
Gruppi di contatti
Mappatura campi
| Campo Gruppo di contatti dell'API Contacts | Campo Gruppo di contatti dell'API People |
|---|---|
| atom:aggiornato | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:deleted | metadata.deleted |
| systemGroup | groupType=SYSTEM_CONTACT_GROUP |
Endpoint
Letto
Richiede l'ambito https://www.googleapis.com/auth/contacts o https://www.googleapis.com/auth/contacts.readonly.
- Ottieni un gruppo di contatti specifico utilizzando
people.contactGroups.get - Elenca i gruppi di contatti utilizzando
people.contactGroups.list
Modifica
Richiede l'ambito https://www.googleapis.com/auth/contacts.
- Creare un gruppo di contatti utilizzando
people.contactGroups.create - Aggiornare un gruppo di contatti utilizzando
people.contactGroups.update - Eliminare un gruppo di contatti utilizzando
people.contactGroups.delete Aggiungere o rimuovere contatti dal gruppo di contatti utilizzando
people.contactGroups.members.modify
Ambiti di autorizzazione
L'ambito legacy https://www.google.com/m8/feeds è un alias per l'ambito https://www.googleapis.com/auth/contacts. Ciò significa che le concessioni OAuth esistenti con l'ambito legacy funzioneranno per tutti gli endpoint nell'API People che richiedono l'ambito https://www.googleapis.com/auth/contacts. La lettura e la scrittura di contatti e gruppi di contatti funzioneranno nell'ambito precedente.
L'API People richiede nuovi ambiti per accedere ai dati di "Altri contatti" o della directory. Per gli ambiti richiesti, vedi sopra i dettagli.
Per maggiori dettagli, vedi Autorizzare le richieste.
Librerie client
- Per Apps Script, consulta la sezione Advanced People Service.
- Per le altre lingue supportate, vedi Installazione delle librerie client.