Este documento contiene 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 Obtén más información sobre la autenticación y autorización.
Configurar OAuth 2.0 para la autorización
Configura la pantalla de consentimiento de OAuth y elige los alcances para definir qué información se muestra a los usuarios y revisores de apps, y registra tu app para que puedas publicarla más tarde.
Permisos de la API de Gmail
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los permisos de autorización. Un alcance de autorización es una string 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 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. En general, debes elegir el alcance más reducido posible y evitar solicitar permisos que la app no requiere. Los usuarios otorgan acceso a permisos limitados y claramente descritos.
La API de Gmail admite los siguientes alcances:
| Código de alcance | Descripción | Uso |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Administra borradores y envía correos electrónicos cuando interactúas con el complemento. | No sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Ver tus mensajes de correo electrónico cuando interactúes con el complemento | No sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Ver los metadatos de tus mensajes de correo electrónico cuando se ejecute el complemento | Sensible |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Ver tus mensajes de correo electrónico cuando se ejecute el complemento | Sensible |
https://www.googleapis.com/auth/gmail.labels |
Crea, lee, actualiza y borra solo etiquetas. | No sensible |
https://www.googleapis.com/auth/gmail.send |
Envía solo mensajes. No hay privilegios de lectura ni modificación en el buzón. | 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 eliminar borradores. Enviar mensajes y borradores | Restringido |
https://www.googleapis.com/auth/gmail.insert |
Solo importa y inserta 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, por medio de la Papelera. | Restringido |
https://www.googleapis.com/auth/gmail.metadata |
Lee los metadatos de los recursos, como las etiquetas, los registros del 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 |
Administrar la configuración básica del correo. | Restringido |
https://www.googleapis.com/auth/gmail.settings.sharing |
Administra la configuración de correo electrónico sensible, incluidos los alias y las reglas de reenvío.
Nota: Las operaciones protegidas por este alcance se restringen solo para uso administrativo. 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 total a los buzones de correo de la cuenta, incluida la eliminación permanente de conversaciones y mensajes. Este alcance solo se debe solicitar si tu aplicación necesita borrar conversaciones y mensajes de forma inmediata y permanente, por lo que se omite la Papelera. Todas las demás acciones se pueden realizar con permisos menos permisivos. | Restringido |
En la columna Uso de la tabla anterior, se indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos alcances proporcionan la más pequeña esfera 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 de preparación para la verificación.
Sensibles: Estos permisos permiten el acceso a los datos del usuario de Google y requieren un proceso de verificación de alcance sensible. Para obtener información sobre este requisito, consulta Política sobre los datos del usuario de los servicios de las API de Google. Estos permisos no requieren una evaluación de seguridad.
Restringido: Estos permisos proporcionan un amplio acceso a los datos del usuario de Google y requieren que realices un proceso de verificación de alcance restringido. Para obtener información sobre este requisito, consulta Servicios de las API de Google: Política sobre los datos del usuario y Requisitos adicionales para permisos específicos de la API. Si almacenas datos de alcance restringido en servidores (o transmites), 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 acceder a los datos del usuario en la Política para Desarrolladores y Datos del Usuario de los Servicios de la API de Gmail.
Si tu app requiere acceso a cualquier otra API de Google, también puedes agregar esos permisos. Si deseas obtener más información sobre los alcances de la API de Google, consulta Usa OAuth 2.0 para acceder a las API de Google.
Verificación de OAuth
El uso de ciertos alcances sensibles de OAuth puede requerir que tu app se someta al 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 sobre los Datos del Usuario de los Servicios de las API de Google.