La API de contactos compartidos con el dominio permite a tus aplicaciones obtener y actualizar contactos externos que se comparten con todos los usuarios en un dominio de Google Workspace. Todos los usuarios de un dominio de Google Workspace pueden ver los contactos compartidos, y todos los servicios de Google tienen acceso a la lista de contactos.
Tu aplicación puede usar la API de contactos compartidos con el dominio para crear contactos compartidos, editar o borrar los contactos compartidos existentes y consultar los contactos compartidos que coincidan con criterios específicos.
La API de contactos compartidos con el dominio solo está disponible para las cuentas de Google Workspace. Para usar la API, habilita la API de contactos compartidos con el dominio en la Consola del administrador. Los cambios de contactos compartidos pueden tardar hasta 24 horas en reflejarse en el autocompletado de direcciones de correo electrónico y en el administrador de contactos.
Además de proporcionar información general sobre las capacidades de la API de contactos compartidos con el dominio, en este documento se ofrecen ejemplos sobre cómo administrar contactos mediante XML y HTTP. Después de leer este documento, puedes obtener más información sobre cómo interactuar con la API mediante nuestras bibliotecas cliente.
Público
Este documento está dirigido a desarrolladores que deseen crear aplicaciones cliente para manipular las listas de contactos de Google mediante HTTP y XML. En este documento, se supone que comprendes los conceptos básicos del protocolo de las API de datos de Google.
Si usas un sistema operativo UNIX y deseas probar los ejemplos en este documento sin escribir ningún código, usa las utilidades de línea de comandos de UNIX curl o wget. Aprende a usar cURL con los servicios de datos de Google.
Principios
Esta versión de la API de contactos compartidos con el dominio sigue los principios de las API de datos de Google. Las API de datos de Google se basan en los formatos de distribución de Atom 1.0 y RSS 2.0, además del protocolo de publicación Atom.
Especifica una versión
Cada solicitud que envíes mediante la API de contactos compartidos con el dominio debe especificar la versión 3.0 de la API:
GData-Version: 3.0
Si no puedes establecer encabezados HTTP, puedes especificar v=3.0 como un parámetro de consulta en la URL, pero se recomienda el método de encabezado HTTP.