Configurar OAuth

Cuando publicas tu app, hay 4 tareas principales que debes completar para la autenticación y la autorización:

  1. Completa la pantalla de consentimiento de OAuth.
  2. Crea tu credencial de OAuth 2.0.
  3. Configura todos los permisos que la app necesita para ejecutarse en el SDK de Google Workspace Marketplace
  4. Envía tu app para la verificación de OAuth.

Los alcances que agregues a cada sitio deben coincidir y se usan de las siguientes maneras:

  • Los permisos agregados a la pantalla de consentimiento de OAuth se usan para la verificación de OAuth.
  • Los permisos agregados al SDK de Google Workspace Marketplace se usan para las instalaciones individuales y en todo el dominio a fin de autorizar la app cuando se instala desde Google Workspace Marketplace.
  • Los alcances agregados al manifiesto son necesarios para que tu app funcione correctamente.

Por ejemplo, si publicas una app que incluye un complemento de Hojas de cálculo de Google y un complemento de Documentos de Google, el manifiesto de Apps Script de cada complemento solo incluirá los permisos específicos del complemento. En tu proyecto de Google Cloud, la pantalla de consentimiento de OAuth y el SDK de Google Workspace Marketplace incluyen los permisos de ambos complementos.

Requisitos previos

La pantalla de consentimiento de OAuth es un mensaje que les indica a los usuarios quién solicita acceso a sus datos y a qué tipo de datos permite el acceso tu app.

  1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Pantalla de consentimiento de OAuth.

    Ir a la pantalla de consentimiento de OAuth

  2. Selecciona el tipo de usuario de tu app y, luego, haz clic en Create.
  3. Completa el formulario de registro de la app y, luego, haz clic en Save and Continue.

  4. Si creas una app para usar fuera de tu organización de Google Workspace, haz clic en Agregar o quitar permisos. Te aconsejamos las siguientes prácticas recomendadas cuando seleccionas los permisos:

    • Selecciona los permisos que proporcionan el nivel de acceso mínimo que requiere tu app. Si quieres obtener una lista de los permisos disponibles, consulta Permisos de OAuth 2.0 para las API de Google.
    • Revisa los permisos enumerados en cada una de las tres secciones: permisos no sensibles, permisos sensibles y permisos restringidos. En el caso de los permisos enumerados en las secciones “Tus permisos sensibles” o “Tus permisos restringidos”, intenta identificar permisos no sensibles alternativos para evitar revisiones adicionales innecesarias.
    • Algunos permisos requieren revisiones adicionales de Google. En el caso de las apps que tu organización de Google Workspace usa de manera interna, los permisos no se enumeran en la pantalla de consentimiento, y el uso de permisos restringidos o sensibles no requiere una revisión adicional por parte de Google. Para obtener más información, consulta Categorías de permiso.
  5. Después de seleccionar los permisos que necesita tu app, haz clic en Save and Continue.
  6. Si seleccionaste Externo como tipo de usuario, agrega usuarios de prueba:
    1. En Usuarios de prueba, haz clic en Agregar usuarios.
    2. Ingresa tu dirección de correo electrónico y cualquier otro usuario de prueba autorizado. Luego, haz clic en Guardar y continuar.
  7. Revisa el resumen del registro de tu app. Para realizar cambios, haz clic en Editar. Si el registro de la app es correcto, haz clic en Volver al panel.

2. Crea tu credencial de OAuth 2.0

Según cómo hayas compilado la app, hay dos formas diferentes de crear tus credenciales de OAuth 2.0.

Si compilaste tu app en Apps Script

Cambia tu proyecto de Apps Script de su proyecto predeterminado de Google Cloud a tu proyecto estándar nuevo. Consulta Cambia a un proyecto estándar diferente.

Después de asociar tu proyecto de Apps Script con el proyecto de Google Cloud, se crea automáticamente tu credencial de OAuth 2.0.

Si no usaste Apps Script para compilar tu app, haz lo siguiente:

Para crear tu credencial de OAuth 2.0, consulta las credenciales de ID de cliente de OAuth.

3. Configura los permisos

Proporciona una lista completa de los permisos de OAuth que requiere tu app. Usa siempre los alcances más reducidos posibles.

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, a qué tipo de datos 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 la Cuenta 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 específico posible y evitar solicitar permisos que tu app no requiere. Los usuarios otorgan acceso a permisos limitados y claramente descritos.

4. Enviar para la verificación de OAuth (solo para apps públicas)

Si una app pública usa permisos sensibles o restringidos, debe someterse a un proceso de revisión de la verificación de OAuth.

  • Para la verificación de OAuth, debes enviar un video de demostración que demuestre el recorrido o el flujo que explica el uso de los permisos o datos solicitados a los usuarios.
  • Si tu app usa permisos restringidos, es posible que también deba someterse a una evaluación de seguridad. Consulta Por qué es necesaria la evaluación de seguridad.

Para solicitar la verificación, sigue estos pasos:

  1. En la consola de Google Cloud, ve a Menú > APIs y servicios > Pantalla de consentimiento de OAuth.

    Ir a la pantalla de consentimiento de OAuth

  2. Haz clic en Selector de proyectos y selecciona tu proyecto.
  3. Haz clic en Editar aplicación.
  4. Ingresa la información requerida y haz clic en Enviar para verificación.
  5. En el diálogo Se requiere verificación, ingresa las justificaciones adecuadas y, luego, haz clic en Enviar para iniciar el proceso de verificación.

Si actualizas tu app para usar alcances diferentes que sean sensibles o restrictivos, deberás volver a enviar la app para la verificación de OAuth. No es necesario que la vuelvas a enviar para la revisión de la app.

Diferencias entre la verificación de OAuth y la revisión de apps

La verificación de OAuth es un proceso independiente de la revisión de apps. Se enfoca en garantizar que la pantalla de consentimiento represente con exactitud la identidad y la intención de tu app, y garantiza que la app no use datos del usuario de forma inadecuada. No se podrá aprobar la ficha de la app hasta que completes la verificación de OAuth de la app. Para obtener más información sobre la verificación de OAuth, consulta las Preguntas frecuentes sobre la verificación de la API de OAuth.

La revisión de apps se centra en la información que proporcionas en la API de Google Workspace Marketplace, así como en la funcionalidad y la usabilidad de tu app. Para obtener más información sobre los criterios de revisión de apps, consulta Acerca de la revisión de apps.