La API de Contacts se dio de baja el 19 de enero de 2022. Usa esta guía para obtener información sobre los cambios en los campos, los extremos y los permisos de autorización a medida que migras a la API de People.
Descripción general
La API de People tiene la misma funcionalidad que la API de Contactos heredada para todas las funciones, con las siguientes excepciones en Otros contactos:
Los administradores tienen permisos de solo lectura para "Otros contactos" a través del permiso nuevo. Dado que no se admite el envío de señales de mutación o escritura a "Otros contactos", los usuarios tendrán que agregar el otro contacto como "Mi contacto" si desean actualizar sus campos de datos.
Solo se puede leer la información de contacto básica para "Otros contactos" a través de la API. Por ejemplo, nombre completo, dirección de correo electrónico y número de teléfono.
Además, el alcance anterior de los Contactos (https://www.google.com/m8/feeds), que proporcionaba acceso tanto a los contactos personales como a la información del directorio, se reemplazará por los siguientes:
- Para acceder a los contactos personales:
https://www.googleapis.com/auth/contacts - Para acceder a la información del directorio:
https://www.googleapis.com/auth/directory.readonly
Contactos
Asignación de campos
| Campo de contacto | Campo de persona |
|---|---|
| atom:content | biografías |
| atom:link rel='http://schemas.google.com/contacts/2008/rel#photo' | fotos |
| atom:title | names |
| gContact:Informacióndefacturación | miscKeywords (type=OUTLOOK_BILLING_INFORMATION) |
| gContact:Cumpleaños | cumpleaños |
| gContact:calendarLink | calendarUrls |
| gContact:directoryServer | miscKeywords (type=OUTLOOK_DIRECTORY_SERVER) |
| gContact:evento | eventos |
| gContact:Propiedad extendida | clientData |
| gContact:ID externo | externalIds |
| gContact:archivos | fileAses |
| gContact:género | géneros |
| gContact:groupMembershipInfo | memberships.contactGroupMembership |
| gContact:hobby | intereses |
| gContact:iniciales | Sobrenombres (type=INITIALS) OBSOLETOS |
| gContact:jot type='home' | miscPalabras clave (type=HOME) |
| gContact:jot type='palabras clave' | miscKeywords (type=OUTLOOK_KEYWORD) |
| gContact:jot type='otro' | miscPalabras clave (type=OTHER) |
| gContact:jot type='user' | miscKeywords (type=OUTLOOK_USER) |
| gContact:jot type='work' | miscPalabras clave (type=WORK) |
| gContact:language | idiomas |
| gContact:Nombre de soltera | Sobrenombres OBSOLETOS (type=MAIDEN_NAME) |
| gContact:mileage | miscKeywords (type=OUTLOOK_MILEAGE) |
| gContact:apodo | apodos (type=DEFAULT) |
| gContact:ocupación | profesiones |
| gContact:prioridad | miscKeywords (type=OUTLOOK_PRIORITY) |
| gContact:relación | relaciones |
| gContact:sensibilidad | miscKeywords (type=OUTLOOK_SENSITIVITY) |
| gContact:Nombrecorto | Sobrenombres OBSOLETOS (type=SHORT_NAME) |
| gContact:asunto | miscKeywords (type=OUTLOOK_SUBJECT) |
| gContact:userDefinedField | userDefined |
| gContact:sitio web | urls |
| gContact:yomiName | names.phonetic_full_name |
| gd:eliminado | metadata.deleted |
| gd:email | emailAddresses |
| gd:im | imClients |
| gd:organización | organizations |
| gd:phoneNumber | phoneNumbers |
| gd:postalAddress | addresses.formattedValue |
| gd:dónde | residencias |
| gd:structuredPostalAddress | direcciones |
Extremos de contactos personales
Leer
Requiere el permiso https://www.googleapis.com/auth/contacts o https://www.googleapis.com/auth/contacts.readonly.
- Leer a un solo contacto específico
people.get - Leer varios contactos específicos
people.getBatchGet - Leer contactos con
people.connections.list
Modificación
Requiere el permiso https://www.googleapis.com/auth/contacts. Muta todos los campos de los contactos, excepto las fotos.
- Crear un contacto con
people.createContact - Actualiza un contacto existente con
people.updateContact. - Borra un contacto con
people.deleteContact.
Modificación de foto
Requiere el permiso https://www.googleapis.com/auth/contacts.
- Actualiza la foto de un contacto con
people.updateContactPhoto. - Borra la foto de un contacto con
people.deleteContactPhoto.
Otros extremos de contactos
Leer
Otros contactos son de solo lectura y solo se muestran los campos names, emailAddresses y phoneNumbers.
Requiere el permiso https://www.googleapis.com/auth/contacts.other.readonly.
- Lee otros contactos con
otherContacts.list.
Texto
Requiere los permisos https://www.googleapis.com/auth/contacts.other.readonly y https://www.googleapis.com/auth/contacts.
- Copia otros contactos con
otherContacts.copyOtherContactToMyContactsGroup.
Extremos de la lista de direcciones global
Requiere el permiso https://www.googleapis.com/auth/directory.readonly.
- Muestra una lista de todos los contactos y perfiles del directorio
people.listDirectoryPeople. - Busca perfiles y contactos del directorio
people.searchDirectoryPeople.
Grupos de contactos
Asignación de campos
| Campo Grupo de contactos de la API de Contactos | Campo del grupo de contactos de la API de People |
|---|---|
| atom:actualizado | metadata.updateTime |
| atom:title | name |
| atom:content | name |
| gd:eliminado | metadata.deleted |
| systemGroup | groupType=SYSTEM_CONTACT_GROUP |
Extremos
Leer
Requiere el permiso https://www.googleapis.com/auth/contacts o https://www.googleapis.com/auth/contacts.readonly.
- Obtén un grupo de contactos específico con
people.contactGroups.get. - Genera una lista de grupos de contactos con
people.contactGroups.list
Modificación
Requiere el permiso https://www.googleapis.com/auth/contacts.
- Crear un grupo de contactos con
people.contactGroups.create - Actualizar un grupo de contactos con
people.contactGroups.update - Borrar un grupo de contactos con
people.contactGroups.delete Agrega contactos al grupo de contactos o quítalos con
people.contactGroups.members.modify
Permisos de autorización
El alcance heredado https://www.google.com/m8/feeds es un alias para el alcance https://www.googleapis.com/auth/contacts. Esto significa que los otorgamientos de OAuth existentes con el permiso heredado funcionarán para cualquier extremo de la API de People que requiera el permiso https://www.googleapis.com/auth/contacts. La lectura y escritura de los contactos y los grupos de contactos funcionará con el alcance heredado.
La API de People requiere nuevos permisos para acceder a "Otros contactos" o datos del directorio. Consulta los detalles anteriores para conocer los permisos necesarios.
Para obtener más información, consulta Autoriza solicitudes.
Bibliotecas cliente
- Para Apps Script, consulta Servicio de personas avanzadas.
- Para obtener información sobre otros lenguajes compatibles, consulta Instala bibliotecas cliente.