Configuración del proyecto de Google Cloud

En esta página, se incluye la información que necesitas saber para crear y configurar proyectos de Google Cloud para complementos de Classroom. Los proyectos de Google Cloud se usan para implementar el inicio de sesión único de Google a través de OAuth 2.0 (SSO de Google), para autorizar las solicitudes que realiza tu complemento y para administrar la ficha de un complemento en la tienda de Google Workspace Marketplace.

Para obtener información más general sobre cómo publicar un complemento en el mercado, consulta Cómo publicar una app.

Creación de proyectos de Google Cloud

Existen dos tipos de proyectos que se pueden crear: un proyecto privado que se usa para el desarrollo y un proyecto público al que pueden acceder los usuarios finales. Las etiquetas “pública” y “privada” se refieren a la visibilidad de tu aplicación en Google Workspace Marketplace. Solo los usuarios del dominio en el que se creó una aplicación privada de Marketplace pueden instalarla, mientras que una aplicación pública de Marketplace está disponible para cualquier dominio de Google Workspace. Deben ser dos aplicaciones separadas, ya que un proyecto no puede ser público y privado. Las solicitudes públicas deben revisarse y aprobarse antes de que estén disponibles en el mercado.

Para obtener información general sobre la creación de proyectos de Google Cloud, consulta Cómo crear un proyecto de Google Cloud.

Crea un proyecto público de Google Cloud

Este proyecto representa la aplicación del complemento a la que pueden acceder los administradores, los profesores y los estudiantes. El equipo de Google Workspace Marketplace debe revisar y aprobar un proyecto público antes de que se pueda instalar o lanzar.

  1. Crea un proyecto de Google Cloud nuevo en tu dominio de producción.

    Crea un proyecto de Google Cloud

  2. Habilita la API de Classroom en tu proyecto de Cloud.

    Habilita la API de Classroom

  3. Habilita el SDK de Google Workspace Marketplace en tu proyecto de Cloud.

    Habilita el SDK de Google Workspace Marketplace

  4. Establece la configuración de la app Visibilidad de la app del SDK de Marketplace en Pública y marca la casilla No listada.

  5. Completa los campos obligatorios en la página Ficha de Play Store del SDK de Marketplace y haz clic en PUBLICAR.

  6. El equipo de Google Workspace Marketplace revisará tu app. Se comunicarán contigo a través de la dirección de correo electrónico del desarrollador especificada en el SDK de Marketplace. Una vez que se apruebe la app, borra la casilla No en la lista para que los profesores y administradores puedan encontrarla en Marketplace.

Crea un proyecto privado de Google Cloud

Este proyecto privado representa la aplicación del complemento que se usa para el desarrollo. Los usuarios fuera del dominio en el que se creó no pueden acceder a él, pero no es necesario que se apruebe antes de la instalación. Por lo tanto, Google recomienda usar este proyecto para desarrollar y probar tu complemento en un entorno controlado.

Para crear un proyecto privado, necesitas acceso a un dominio de Google Workspace for Education con la licencia Teaching & Learning o Plus. Si aún no tienes acceso a un dominio de este tipo, sigue estos pasos para configurar un dominio de demostración de Google Workspace for Education, actualizarlo a una licencia de Plus y permitir que acceda a la API de complementos de Classroom:

  1. Completa los pasos para obtener un dominio de prueba para desarrolladores.

  2. Cuando hayas accedido como administrador en el dominio de demostración, crea un proyecto nuevo de Google Cloud.

    Crea un proyecto de Google Cloud

    Si no puedes acceder a la consola de Google Cloud ni crear proyectos de Cloud, verifica lo siguiente en la consola del administrador:

    • Ve a la página Configuración de la cuenta > Configuración de acceso por edad y selecciona la opción Todos los usuarios de este grupo o unidad organizativa son mayores de 18 años.
    • En Apps > Servicios adicionales de Google, haz lo siguiente:
    • Google Cloud Platform está disponible para todos.
    • La configuración de creación de proyectos es Permitir que los usuarios creen proyectos.
    • La configuración de acceso a Cloud Shell es Permite el acceso a Cloud Shell.

  3. Completa y envía el formulario de solicitud de actualización de dominio de demostración. Si envías este formulario, se le solicitará a Google que actualice tu dominio de demostración a Google Workspace for Education Plus con diez licencias y que permita que tu proyecto de Cloud acceda a la API de complementos de Classroom.

    Recibirás un correo electrónico cuando se completen los procesos de actualización y de la lista de entidades permitidas. Asigna licencias de Plus a tus cuentas de profesores de prueba en la Console del administrador. En Directorio > Usuarios, crea o selecciona las cuentas de los profesores de prueba. En Licencias de cada profesor, confirma que Google Workspace for Education Plus esté Asignada.

  4. Habilita la API de Classroom en tu proyecto de Cloud.

    Habilita la API de Classroom

  5. Habilita el SDK de Google Workspace Marketplace en tu proyecto de Cloud.

    Habilita el SDK de Google Workspace Marketplace

  6. Establece la configuración de la app visibilidad de la app del SDK de Marketplace como privada.

  7. Completa los campos obligatorios en la página Ficha de Play Store del SDK de Marketplace y haz clic en PUBLICAR. Después de que se publique la ficha de la app, los usuarios del dominio podrán encontrarla e instalarla en Google Workspace Marketplace o visitando la URL de la app que se muestra en la página de la ficha de Play Store.

OAuth 2.0

El acceso a la API de Classroom requiere el consentimiento de acceso a los datos del usuario. Para obtenerlos, debes solicitar a Google acceso a los permisos de OAuth para el usuario que accedió y recibir un token que se puede usar para realizar llamadas a la API de Google Classroom posteriormente. Los permisos se deben configurar en la ficha de Google Workspace Marketplace para que el administrador del dominio pueda dar su consentimiento en nombre de los usuarios del dominio si instalan el complemento.

Debido a que los permisos de Classroom son sensibles, debes solicitar la verificación de OAuth antes de iniciar el complemento. De lo contrario, los usuarios verán un mensaje de advertencia que indica que la aplicación no está verificada y solo una pequeña cantidad de usuarios podrá acceder a tu producto. Consulta la descripción general de la secuencia de revisión para obtener más información sobre la verificación.

Consulta la página Permisos de OAuth para las APIs de Google para obtener una lista detallada de todos los permisos disponibles y sus usos. Consulta la página Configura OAuth en la documentación de Workspace para obtener información general sobre la configuración de OAuth.

Permisos de usuario

Tu app web debe solicitar al menos uno de los siguientes permisos:

  • https://www.googleapis.com/auth/userinfo.email, que permite que una aplicación vea la dirección de correo electrónico del usuario.
  • https://www.googleapis.com/auth/userinfo.profile, que permite que una aplicación vea información personal, como el retrato, el nombre y el apellido, y otra información personal que el usuario haya puesto a disposición del público.

Una vez que un usuario autoriza uno de estos permisos en tu complemento, se lo identifica con el parámetro de consulta login_hint. Este parámetro se pasa a cualquiera de las URLs de tu app web cuando se abre un iframe. Si un usuario no autorizó uno de estos permisos, no se enviará login_hint.

login_hint es un parámetro estándar de OpenID Connect que puedes pasar a Google de forma opcional cuando usas el Acceso con Google o solicitas un token de OAuth. Su objetivo es facilitar la experiencia de autorización para el usuario final.

Permisos de los complementos de Classroom

Los siguientes permisos son específicos de los complementos de Classroom:

  • https://www.googleapis.com/auth/classroom.addons.teacher, que permite el acceso a todos los métodos de la API.
  • https://www.googleapis.com/auth/classroom.addons.student, que permite el acceso para iniciar la validación y las operaciones de lectura de archivos adjuntos.

Incluso con un token de acceso de OAuth válido que denote las credenciales del usuario, las llamadas a la API están restringidas por requisitos adicionales:

  • Todos los métodos requieren que el usuario sea profesor o estudiante del curso que especifica el courseId en la solicitud.
  • Para crear, actualizar, borrar y pasar calificaciones de adjuntos, el usuario debe ser profesor.
  • Las llamadas a una publicación específica de Google Classroom están restringidas por las siguientes verificaciones.
    • Cuando un complemento ya tiene al menos un archivo adjunto en una publicación, puede realizar solicitudes para lo siguiente:
      • Validación del inicio de iframe
      • Operaciones de lectura, actualización y eliminación de archivos adjuntos
      • Actualizaciones de calificaciones en esa publicación
    • Cuando se abre el iframe de descubrimiento de archivos adjuntos por primera vez, es posible que el complemento aún no tenga un archivo adjunto en la publicación. Se proporciona un parámetro de consulta addOnToken que se puede usar para realizar solicitudes de lo siguiente:
      • Cómo crear un archivo adjunto debajo de la publicación (se requiere addOnToken)
      • Validación del lanzamiento (addOnToken se valida si se proporciona y es obligatoria cuando el complemento no tiene un archivo adjunto existente en la publicación)

Verificación de OAuth

Un complemento de Classroom usa las APIs de Google para acceder a los datos de los usuarios de Google.

Consulta las Preguntas frecuentes sobre la verificación de la API de OAuth para obtener más información sobre el proceso de verificación.

Ficha de Google Workspace Marketplace

Para obtener información general sobre la configuración del SDK de Google Workspace Marketplace, consulta Habilita y configura el SDK de Google Workspace Marketplace y Cómo crear una ficha de Play Store de Google Workspace Marketplace.

Consideraciones sobre las fichas

La ficha de la tienda del SDK de Marketplace de tu proyecto público de Google Cloud especifica el nombre y las descripciones de tu aplicación para los usuarios finales. Puedes proporcionar estos detalles en varios idiomas en Detalles de la app.

Sigue estos lineamientos en tus fichas:

  • En Detalles de la app, haz lo siguiente:

    • Evita usar signos de puntuación en el nombre de la aplicación. Por ejemplo, usa "Mi complemento de Mi empresa" en lugar de "Mi empresa: Mi complemento" o "Mi complemento de Mi empresa".

    • La descripción breve y la descripción detallada no deben contener exactamente el mismo texto.

    + Asegúrate de haber seleccionado un valor para el campo Precio. Este campo incluye opciones de precios Gratis, Pagado con prueba gratuita, Pagado con funciones gratuitas y Pagado. No necesitas especificar el importe del costo en la ficha del mercado.

    • Asegúrate de haber seleccionado un valor para el campo Categoría. Recursos académicos o Herramientas para profesores y administradores podrían ser buenas opciones para un complemento de Classroom.

    • Consulta los elementos que se indican en la descripción de los detalles de la app de Marketplace para obtener más información.

Integra los servicios de licencias y facturación de Google

Si te interesa permitir que tus aplicaciones de Google Workspace Marketplace se integren con los servicios de facturación y licencias de Google, visita la API de Marketplace.

Configuración de la instalación

Los complementos pueden permitir la instalación individual, además de la instalación del administrador. En esta página, se destacan algunas diferencias entre los dos tipos de instalación. No tiene como objetivo promocionar ninguno de los tipos de instalación. Puedes elegir si permites la instalación individual en la página de configuración de la app del SDK de Google Workspace Marketplace.

Instalación de administrador

Las instalaciones de administrador permiten que un administrador agregue un complemento a todas las cuentas de un dominio o a unidades organizativas o grupos de acceso específicos. Solo un administrador del dominio puede realizar una instalación de administrador. De manera opcional, el administrador puede dar su consentimiento para todos los permisos de acceso en nombre de todos los usuarios del dominio. No se les pedirá a los usuarios que den su consentimiento para ningún permiso de acceso si el administrador decide hacerlo.

A continuación, se incluyen algunas consideraciones sobre la instalación del administrador.

  • Controles más estrictos. Los administradores pueden restringir qué usuarios pueden acceder a un complemento.
  • Compatibilidad con las licencias. Si tu aplicación requiere una licencia, canaliza las instalaciones a través de un administrador para garantizar que las licencias se distribuyan y usen de manera adecuada con la institución correspondiente.
  • Menor carga para los usuarios finales. Una instalación de administrador reduce la carga de configuración para profesores y alumnos. Esto podría generar una experiencia del usuario más fluida con menos clics y menos oportunidades de confusión.

Consulta Cómo instalar apps de Marketplace en tu dominio para obtener más información sobre cómo realizar instalaciones de administrador y Cómo funciona la estructura organizativa para obtener más información sobre las unidades organizativas y los grupos de acceso.

Instalación individual

Las instalaciones individuales agregan un complemento a la cuenta del usuario. Se le solicita al usuario que otorgue su consentimiento a los permisos de acceso del complemento durante la instalación.

A continuación, se incluyen algunas consideraciones sobre la instalación individual.

  • Facilitar la adopción Más usuarios pueden ver e instalar tu complemento desde Google Workspace Marketplace. Permitir la instalación individual puede motivar a más profesores a adoptar tu producto o a recomendarlo.
  • Pruebas de administrador. Un administrador puede instalar un complemento de forma individual para probarlo o evaluarlo antes de aprobarlo o instalarlo para un grupo más amplio.

Además de instalar complementos en nombre de los usuarios, los administradores también pueden mantener una lista de entidades permitidas para permitir que los usuarios instalen complementos que permitan la instalación individual. Si un complemento no está en la lista de entidades permitidas, los usuarios pueden ver su ficha en Google Workspace Marketplace, pero no pueden instalarlo. En su lugar, ven un mensaje en el que se explica que un administrador de dominio no permitió su instalación. Consulta Cómo administrar las apps de Google Workspace Marketplace en tu lista de entidades permitidas para obtener más información sobre este comportamiento.

Consulta la documentación de configuración de instalación de Google Workspace Marketplace para obtener más información.

Integraciones de la app

Debes proporcionar una URL de iframe de inicio en el campo URI de configuración de archivos adjuntos. Esta URL se usa como el valor src del iframe para el iframe de descubrimiento de archivos adjuntos. Los profesores usan el iframe de descubrimiento de archivos adjuntos para encontrar contenido o actividades que adjuntar a sus tareas.

También debes especificar todos los prefijos de URI desde los que se permiten los archivos adjuntos desde tu complemento. Esta función aumenta la seguridad, ya que evita que se agreguen archivos adjuntos de fuentes no autorizadas.

Consulta la página de la guía de iframes para obtener más detalles sobre estos campos.

Cuentas de prueba

Crea cuentas de prueba en tu dominio de demostración para verificar el comportamiento correcto de tu complemento privado. Se necesitan dos cuentas de estudiante para probar el cambio entre estudiantes en el iframe de Revisión de trabajos de estudiantes.

Cuentas de prueba sugeridas:

  • Tamara Profesora, tammy.profesora@<tu dominio de demostración>
  • Sam Student, sam.student@<tu dominio de demostración>
  • Sally Student, sally.student@<your demo domain>

Sigue este procedimiento para crear una nueva cuenta de prueba:

  1. Accede a la Consola del administrador.
  2. Navega a Usuarios.
  3. Haz clic en Agregar usuario nuevo (consulta la Figura 1).
  4. Ingresa la información del usuario y asígnale los roles adecuados.

Haz clic en Agregar usuario nuevo. Figura 1: Ubicación del vínculo Agregar usuario nuevo en la Consola del administrador

Sigue este procedimiento para crear un nuevo grupo de prueba:

  1. Accede a la Consola del administrador.
  2. Navega a Grupos.
  3. Haz clic en Crear grupo (consulta la Figura 2).
  4. Ingresa los miembros y propietarios del grupo.

Haz clic en Crear grupo. Figura 2: Ubicación del vínculo Crear grupo en la Consola del administrador.