En este documento, se incluye información de autorización y autenticación específica de la API de Gmail. Antes de leer este documento, asegúrate de leer la información general de autenticación y autorización de Google Workspace en Más información sobre la autenticación y la autorización.
Configura OAuth 2.0 para la autorización
Configura la pantalla de consentimiento de OAuth y elige permisos para definir qué información se muestra a los usuarios y revisores de apps, y registra tu app para que puedas publicarla más adelante.
Permisos de la API de Gmail
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los alcances de autorización. Un alcance de autorización es una cadena de URI de OAuth 2.0 que contiene el nombre de la app de Google Workspace, el tipo de datos a los que accede y el nivel de acceso. Los permisos son las solicitudes de tu app para trabajar con los datos de Google Workspace, incluidos los datos de las Cuentas de Google de los usuarios.
Cuando se instala tu app, se le solicita al usuario que valide los permisos que esta usa. Por lo general, debes elegir el permiso más específico posible y evitar solicitar permisos que tu app no requiera. Los usuarios otorgan acceso con mayor facilidad a permisos limitados y descritos con claridad.
La API de Gmail admite los siguientes permisos de acceso:
| Código de alcance | Descripción | Uso |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Administrar borradores y enviar correos electrónicos cuando interactúes con el complemento | No sensibles |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Ver tus mensajes de correo electrónico cuando interactúes con el complemento | No sensibles |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Ver los metadatos de tus mensajes de correo electrónico cuando se ejecuta el complemento | Sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Ver tus mensajes de correo electrónico cuando se esté ejecutando el complemento | Sensible |
https://www.googleapis.com/auth/gmail.labels |
Solo puedes crear, leer, actualizar y borrar etiquetas. | No sensibles |
https://www.googleapis.com/auth/gmail.send |
Solo enviar mensajes No tiene privilegios de lectura ni modificación en el buzón de correo. | Sensible |
https://www.googleapis.com/auth/gmail.readonly |
Lee todos los recursos y sus metadatos, sin operaciones de escritura. | Restringido |
https://www.googleapis.com/auth/gmail.compose |
Crear, leer, actualizar y borrar borradores Enviar mensajes y borradores | Restringido |
https://www.googleapis.com/auth/gmail.insert |
Solo inserta e importa mensajes. | Restringido |
https://www.googleapis.com/auth/gmail.modify |
Todas las operaciones de lectura y escritura, excepto la eliminación inmediata y permanente de conversaciones y mensajes, sin pasar por la Papelera | Restringido |
https://www.googleapis.com/auth/gmail.metadata |
Lee los metadatos de los recursos, incluidas las etiquetas, los registros de historial y los encabezados de los mensajes de correo electrónico, pero no el cuerpo del mensaje ni los archivos adjuntos. | Restringido |
https://www.googleapis.com/auth/gmail.settings.basic |
Administra la configuración básica del correo. | Restringido |
https://www.googleapis.com/auth/gmail.settings.sharing |
Administra la configuración del correo confidencial, incluidas las reglas de reenvío y los alias.
Nota: Las operaciones protegidas por este permiso solo se pueden usar de forma administrativa. Solo están disponibles para los clientes de Google Workspace que usan una cuenta de servicio con delegación de todo el dominio. |
Restringido |
https://mail.google.com/ |
Acceso completo a los buzones de correo de la cuenta, incluida la eliminación permanente de conversaciones y mensajes. Este permiso solo debe solicitarse si tu aplicación necesita borrar conversaciones y mensajes de forma inmediata y permanente, sin pasar por la Papelera. Todas las demás acciones se pueden realizar con permisos menos permisivos. | Restringido |
La columna Uso en la tabla anterior indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos permisos proporcionan el ámbito más pequeño de acceso de autorización y solo requieren una verificación básica de la app. Para obtener información sobre este requisito, consulta Pasos para prepararte para la verificación.
Sensible: Estos permisos permiten el acceso a los datos del usuario de Google y requieren un proceso de verificación de permisos sensibles. Para obtener información sobre este requisito, consulta la Política de Datos del Usuario de los Servicios de las APIs de Google. Estos permisos no requieren una evaluación de seguridad.
Restringidos: Estos permisos proporcionan un acceso amplio a los datos del usuario de Google y requieren que realices un proceso de verificación de permisos restringidos. Para obtener información sobre este requisito, consulta la Política de Datos del Usuario de los Servicios de las APIs de Google y los Requisitos Adicionales para Permisos Específicos de API. Si almacenas (o transmites) datos de alcance restringido en servidores, debes realizar una evaluación de seguridad.
Puedes encontrar información adicional que rige el uso y el acceso a las APIs de Gmail cuando solicitas acceso a los datos del usuario en la Política de Datos del Usuario y del Desarrollador de los Servicios de la API de Gmail.
Si tu app requiere acceso a otras APIs de Google, también puedes agregar esos permisos. Si deseas obtener más información sobre los permisos de las APIs de Google, consulta Usa OAuth 2.0 para acceder a las APIs de Google.
Verificación de OAuth
El uso de ciertos alcances de OAuth sensibles puede requerir que tu app realice el proceso de verificación de OAuth de Google. Lee las Preguntas frecuentes sobre la verificación de OAuth para determinar cuándo se debe verificar tu app y qué tipo de verificación se requiere. Consulta también la Política de Datos del Usuario de los Servicios de las APIs de Google.