Este documento contiene información específica de la API de Gmail sobre la autorización y la autenticación. Antes de leer este documento, asegúrate de leer la información general sobre la autenticación y la 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 que se otorga 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 datos de Google Workspace, incluidos los datos de las Cuentas de Google de los usuarios.
Cuando se instala tu app, se le pide al usuario que valide los alcances que usa la app. Por lo general, debes elegir el alcance más específico posible y evitar solicitar alcances que tu app no necesite. Los usuarios otorgan acceso más fácilmente a los 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 |
Administrar borradores y enviar correos electrónicos cuando interactúes 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 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 pueden crear, leer, actualizar y borrar etiquetas. | No sensible |
https://www.googleapis.com/auth/gmail.send |
Solo enviar mensajes No tiene privilegios de lectura o modificación en el buzón. | Sensible |
https://www.googleapis.com/auth/gmail.readonly |
Leer 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 se pueden insertar e importar mensajes. | Restringido |
https://www.googleapis.com/auth/gmail.modify |
Todas las operaciones de lectura y escritura, excepto la eliminación inmediata y permanente de hilos y mensajes, sin pasar por la Papelera. | Restringido |
https://www.googleapis.com/auth/gmail.metadata |
Leer los metadatos de los recursos, incluidos los registros de etiquetas y de historial, y los encabezados de los mensajes de correo electrónico, pero no el cuerpo ni los archivos adjuntos de los mensajes | 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 |
Administrar la configuración del correo confidencial, incluidas las reglas de reenvío y los alias
Nota: Las operaciones protegidas por este alcance se restringen solo al uso administrativo. Solo están disponibles para los clientes de Google Workspace que usan una cuenta de servicio con delegación para todo el dominio. |
Restringido |
https://mail.google.com/ |
Acceso completo a los buzones de correo de la cuenta, incluido el borrado permanente de hilos y mensajes: Este alcance solo se debe solicitar si tu aplicación necesita borrar de forma inmediata y permanente hilos y mensajes, sin pasar por la Papelera. Todas las demás acciones se pueden realizar con alcances menos permisivos. | Restringido |
La columna Uso de la tabla anterior indica la sensibilidad de cada alcance, según las siguientes definiciones:
No sensibles: Estos permisos proporcionan la menor esfera de acceso de autorización y solo requieren la verificación básica de la app. Para obtener información sobre este requisito, consulta Pasos para prepararse 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 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 amplio acceso a los datos del usuario de Google y requieren que pases por 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 datos de alcance restringido en servidores (o los transmites), debes someterte a una evaluación de seguridad.
En la Política de Datos del Usuario y Política para Desarrolladores de los Servicios de la API de Gmail, puedes encontrar información adicional que rige tu uso y acceso a las APIs de Gmail cuando solicitas acceso a los datos del usuario.
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 sensibles de OAuth puede requerir que tu app pase por el proceso de verificación de OAuth de Google. Lee las Preguntas frecuentes sobre la verificación de OAuth para determinar cuándo tu app debe someterse a la verificación 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.