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 lugar 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 instalaciones individuales y para todo el dominio para autorizar tu app cuando se instala desde Google Workspace Marketplace.
  • Los permisos agregados al manifiesto son necesarios para que la 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 incluye 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 los usuarios permiten que acceda 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 Crear.
  3. Completa el formulario de registro de la app y, luego, haz clic en Guardar y continuar.
  4. Si creas una app para usar fuera de tu organización de Google Workspace, haz clic en Agregar o quitar permisos. Recomendamos las siguientes prácticas recomendadas cuando selecciones los permisos:

    • Selecciona los permisos que proporcionan el nivel mínimo de acceso que requiere tu app. Para obtener una lista de los permisos disponibles, consulta Alcances de OAuth 2.0 para las APIs de Google.
    • Revisa los permisos que se enumeran en cada una de las tres secciones: permisos no sensibles, permisos sensibles y permisos restringidos. En el caso de los permisos que se enumeran en las secciones "Tus permisos sensibles" o "Tus permisos restringidos", intenta identificar permisos alternativos que no sean sensibles para evitar revisiones adicionales innecesarias.
    • Algunos permisos requieren revisiones adicionales por parte de Google. En el caso de las apps que solo usa internamente tu organización de Google Workspace, los permisos no se incluyen 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 alcance.
  5. Después de seleccionar los permisos necesarios para tu app, haz clic en Guardar y continuar.
  6. Si seleccionaste Externo como el 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 los demás usuarios de prueba autorizados, y 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 parece correcto, haz clic en Volver al panel.

2. Crea tu credencial de OAuth 2.0

Según cómo compilaste tu app, existen dos maneras 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 nuevo y estándar. Consulta Cómo cambiar a un proyecto estándar diferente.

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

Si no usaste Apps Script para compilar tu app

Para crear tu credencial de OAuth 2.0, consulta Crea un ID de cliente de OAuth 2.0.

3. Configura los permisos

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

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.

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 verificación de OAuth.

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

Para enviar el contenido para su 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 app.
  4. Ingresa la información requerida y, luego, haz clic en Enviar para verificación.
  5. En el diálogo Verificación obligatoria, ingresa las justificaciones adecuadas y, luego, haz clic en Enviar para iniciar el proceso de verificación.

Si actualizas tu app para usar diferentes permisos sensibles o restrictivos, deberás volver a enviarla para su verificación de OAuth. No es necesario que la envíes nuevamente para su revisión.

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 precisión la identidad y el propósito de tu app, y que no haga un uso inadecuado de los datos del usuario. No se puede aprobar la ficha de tu app hasta que se complete la verificación de OAuth. 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 enfoca en la información que proporcionas en la API de Google Workspace Marketplace, así como en la funcionalidad y usabilidad de la app. Para obtener más información sobre los criterios de revisión de apps, consulta Acerca de la revisión de apps.