Configuración del proyecto de Google Cloud

Esta página 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), autorizar las solicitudes realizadas por el complemento y administrar una del complemento en Google Workspace Marketplace en una tienda física.

Para obtener más información general sobre la publicación de un complemento en Marketplace consulta Publica una app.

Creación de proyectos de Google Cloud

Punto clave: La aplicación de complemento de producción debe tener visibilidad pública se establecen en el SDK de Google Workspace Marketplace. Un proyecto privado puede ser útil para desarrollar y probar tu complemento, pero solo se requiere uno público.

Existen dos tipos de proyectos para crear: uno privado, que se usa para y un proyecto público al que pueden acceder los usuarios finales. El "público" y “privado” las etiquetas se refieren a la visibilidad de tu aplicación en Google Workspace Marketplace un mercado privado aplicación solo la pueden instalar los usuarios del dominio en el que se encontraba una aplicación de Marketplace pública disponibles para cualquier dominio de Google Workspace. Deben ser dos valores separados aplicaciones, ya que un proyecto no puede ser público ni privado. Aplicaciones públicas se deben revisar y aprobar antes de que estén disponibles en Marketplace.

Importante: No puedes convertir un proyecto privado en uno público.

Para obtener información general sobre la creación de proyectos de Google Cloud, visita Crea un proyecto de Google Cloud.

Crea un proyecto público de Google Cloud

Este proyecto representa la aplicación complementaria a la que pueden acceder administradores, profesores y estudiantes. Un proyecto público debe revisarse y la aprobación del equipo de Google Workspace Marketplace antes de que se pueda lanzar o esté instalado.

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

   Crea un proyecto de Google Cloud

   Importante: Asegúrate de que el proyecto pertenezca a tu dominio de producción y que Accediste a la consola de Google Cloud como usuario de ese dominio.
   Advertencia: Debes usar la versión de borrador de tu proyecto para realizar pruebas. En esta vez, la función Borrador solo está disponible a través de la Programa de versión preliminar para desarrolladores de Google Workspace. Después de crear tu proyecto de Cloud, completa los formulario de solicitud para habilitar las funciones del Programa de versión preliminar para desarrolladores de Google Workspace. Para ver más consulta Cómo actualizar la ficha de la app con borradores.

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

   Habilitar la API de Classroom

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

   Habilitar el SDK de Google Workspace Marketplace

4. Configura el SDK de Marketplace Configuración de la app Visibilidad de la app como Público y marca la casilla No listada.

   Punto clave: No puedes compartir ni convertir un proyecto privado que se usó durante desarrollo y pruebas.
   Punto clave: Las apps no listadas Google Workspace Marketplace a través de la navegación o la búsqueda En el configuración del SDK de Marketplace, puedes encontrar una URL directa que se puede usar para instalar el complemento. Solo Google y el desarrollador pueden buscar la ficha de Play Store. Tu app debe permanecer como no listada hasta que de lanzarla al público en general. Puedes activar o desactivar la opción complemento aparece en la página Configuración de la aplicación de la SDK de Marketplace.

5. Completa los campos obligatorios en el SDK de Marketplace Ficha de Play Store y haz clic en PUBLICAR.

6. El equipo de Google Workspace Marketplace revisará tu app. Ellas se comunicará contigo mediante la dirección de correo electrónico de desarrollador que se especifica en el SDK de Marketplace. Una vez que se apruebe la app, borra el cuadro No listado para que los profesores y administradores puedan encontrarlo en la Marketplace.

Crea un proyecto privado de Google Cloud

Este proyecto privado representa la aplicación complementaria utilizada para el desarrollo. No es accesible para los usuarios fuera del dominio en el que se creó, pero no es necesario que esté aprobada antes de la instalación. Por lo tanto, Google recomienda usando este proyecto para desarrollar y probar tu complemento en un entorno controlado.

Necesitas acceso a un dominio de Google Workspace for Education con los programas Teaching & Learning o Plus para crear un proyecto privado. Si aún no tienes acceso a este tipo dominio, sigue estos pasos para configurar un dominio de demostración de Google Workspace for Education y actualízalo a un Además, debes tener licencia y permitir que acceda a la API de complementos de Classroom:

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

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

   Crea un proyecto de Google Cloud

   Advertencia: Asegúrate de que el proyecto pertenezca al dominio de demostración y de que Se accedió a la consola de Google Cloud con una cuenta de administrador de la demostración. dominio.

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

   • Visita la sección Configuración de la cuenta > página de Configuración de acceso por edad y selecciona la opción Todos los usuarios de este grupo o unidad organizativa son 18 o anteriores.
   • En Aplicaciones > Servicios adicionales de Google:
   • Google Cloud Platform está ACTIVADO para todos.
   • La configuración de creación de proyectos es Permitir que los usuarios creen proyectos.
   • La configuración de acceso de Cloud Shell es Permitir el acceso a Cloud Shell.

3. Completa y envía el formulario de solicitud de actualización del dominio de demostración. Enviando esto solicitudes de formulario para que Google actualice tu dominio de demostración a Google Workspace for Education Plus con diez de Google Cloud y permite que tu proyecto de Cloud API de complementos de Classroom.

   Recibirás un correo electrónico cuando se modifiquen los procesos de actualización y de lista de entidades permitidas. que se completó. Asigna licencias de Plus a tus cuentas de profesores de prueba en el Consola del administrador. Por debajo Directorio > Usuarios, crea o selecciona tus cuentas de profesores de prueba. En cada Licencias del profesor, confirma que se haya Asignado Google Workspace for Education Plus.

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

   Habilitar la API de Classroom

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

   Habilitar el SDK de Google Workspace Marketplace

6. Configura el SDK de Marketplace Configuración de la app Visibilidad de la app a privada.

7. Completa los campos obligatorios en el SDK de Marketplace Ficha de Play Store y haz clic en PUBLICAR. Después de que se publica la ficha de la app, los usuarios del dominio pueden buscar e instalar la app en Google Workspace Marketplace. Para ello, visita la URL de la aplicación que aparece en la página de la ficha de Play Store.

OAuth 2.0

Para acceder a la API de Classroom, se requiere el consentimiento de acceso a los datos del usuario. Estos se obtienen solicitando acceso a Google a los permisos de OAuth para los usuarios que usuario y recibe un token que puede usarse para realizar llamadas a la API posteriormente a Google Classroom Los permisos se deben configurar en la ficha de Play Store de Google Workspace Marketplace para que el administrador del dominio puede dar su consentimiento en nombre de los usuarios de su dominio si instalan el complemento.

Importante: Si tu complemento solicita permisos adicionales, inclúyelos en el archivo OAuth pantalla de consentimiento, la pestaña de la configuración de apps del SDK de Marketplace y el código de la aplicación de tu complemento. Los alcances no coinciden en estas ubicaciones podría causar problemas a los usuarios durante la instalación del complemento.

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

Advertencia: Si usas un proyecto de Google Cloud existente para desarrollar un complemento, No solicites los nuevos alcances en el código para los productos existentes hasta después de la verificación se haya completado. Usar un flujo de autorización independiente, un entorno de pruebas o configurar una marca de función para solicitar solo estos permisos para los complementos rutas antes de completar la verificación.

Consulta la página Alcances de OAuth para las APIs de Google si deseas obtener una lista detallada de todas las APIs disponibles alcances 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 una para ver la dirección de correo electrónico del usuario.
• https://www.googleapis.com/auth/userinfo.profile, que permite una aplicación para ver información personal, como el retrato, el nombre y apellido nombres y otra información personal que el usuario haya hecho pública disponibles.

Después de que un usuario autoriza uno de estos alcances en tu complemento, Se identifica con el parámetro de consulta login_hint. Este parámetro se pasa a cualquier de las URLs de tu app web cuando se abre un iframe. Si un usuario no autorizó uno de estos permisos, no se enviarán login_hint.

Advertencia: Tu app debe solicitar al menos uno de los userinfo.email o userinfo.profile permisos para recibir login_hint en visitas posteriores por el mismo usuario.

login_hint es un parámetro estándar de OpenID Connect que puedes usar opcionalmente. pasar a Google cuando use el Acceso con Google o solicite un token de OAuth. Integra tiene como objetivo que la experiencia de autorización sea más fluida 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 acceso a todos los métodos de API.
• https://www.googleapis.com/auth/classroom.addons.student, que permite para iniciar operaciones de validación y lectura de archivos adjuntos.

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

• Todos los métodos requieren que el usuario sea profesor o estudiante del curso especificadas por el courseId en la solicitud.
• La creación, actualización, eliminación y devolución de calificaciones de archivos adjuntos requieren que el usuario para ser profesor.
• Las llamadas a publicaciones específicas de Google Classroom están restringidas a y verificaciones de control.
  • Cuando un complemento ya tiene al menos un archivo adjunto en una publicación, puede hacer solicitudes para:
    • Validación de inicio de iframe
    • Operaciones de lectura, actualización y eliminación de archivos adjuntos
    • Actualizaciones de calificaciones de esa publicación
  • Cuando se abre el iframe del descubrimiento de archivos adjuntos por primera vez, es posible que el complemento que todavía no tienen archivos adjuntos en la publicación. Un parámetro de consulta addOnToken que se puede usar para hacer solicitudes para lo siguiente:
    • Creando un archivo adjunto debajo de la publicación (addOnToken es obligatorio)
    • Validación de inicio (addOnToken se valida si se proporciona y se obligatorio si el complemento no tiene un archivo adjunto existente en la publicación)

Verificación de OAuth

Nota: No puedes crear un video de demostración para enviarlo como parte del proceso de verificación de OAuth. el proceso de administración de recursos. En su lugar, publica el complemento sin verificar OAuth. Hacerlo alerta al equipo de revisión de Google Workspace Marketplace para que realice un video de demostración sobre por ti. El equipo de revisión te proporcionará el video para que puedas inclúyela cuando envíes la verificación de OAuth.

Un complemento de Classroom usa las APIs de Google para acceder a las contraseñas de datos no estructurados.

• Verifica la identidad de tu marca.
• Verifica los permisos de OAuth sensibles.

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

Ficha de Google Workspace Marketplace

Advertencia: Una vez que guardes la opción de visibilidad durante el proceso de publicación, no podrás cambiar tu selección más adelante.

Para obtener información general sobre la configuración del SDK de Google Workspace Marketplace, visita Habilitar y configurar el SDK de Google Workspace Marketplace y Crea una ficha de Play Store de Google Workspace Marketplace.

Consideraciones de la ficha

La tienda del SDK de Marketplace del proyecto público de Google Cloud Listing especifica el nombre de tu aplicación y descripciones dirigidas a los usuarios finales. Puedes proporcionar estos detalles en varias 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 de la empresa”.

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

  + Asegúrate de haber seleccionado un valor para el campo Pricing (Precios). Esta incluye las opciones Gratuito, Pagado con una prueba gratuita, Pagado con funciones gratuitas y los precios pagados. No es necesario que especifiques el costo en la ficha de Marketplace.

  • Asegúrate de haber seleccionado un valor para el campo Category. Los recursos académicos o las herramientas para profesores y administradores pueden ser buenas opciones para lo siguiente: un complemento de Classroom.

  • Ver los elementos enumerados en la aplicación de Marketplace Detalles del perfil para obtener más información.

Importante: Revisa los detalles de la app de cada idioma en el que ofreces tus complemento.

• En Recursos gráficos, haz lo siguiente:

  • Los recursos gráficos proporcionados no deben ser borrosos y deben cumplir con los tamaños especificados. en los estándares de Google Workspace Marketplace

  • Las capturas de pantalla que proporciones son representaciones precisas de tu complemento. de usuario.

• En Vínculos de asistencia, haz lo siguiente:

  • Asegúrate de haber proporcionado un vínculo a las Condiciones del Servicio de tu aplicación Service.

• Asegúrate de cumplir con los Lineamientos de desarrollo de la marca de la API de Google, incluye los nombres y las descripciones permitidos.

• Si te refieres a algún producto de Google en tu directorio, usa su nombre en formato proporcionado en la Lista de marcas. Asegúrate de incluir el el símbolo de marca comercial (TM), si se especifica; usa "Google DocsTM", no "Google Documentos”.

Integración en los servicios de licencias y facturación de Google

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

Configuración de la instalación

Los complementos pueden permitir la instalación individual, además del administrador. instalación. En esta página, se destacan algunas diferencias entre las dos versiones de tipos de datos. no está diseñado para promocionar ninguno de los dos tipos de instalación. Puedes elegir si permites la instalación individual en el SDK de Google Workspace Marketplace Página Configuración de la app

Instalación del administrador

Las instalaciones para administradores permiten que estos agreguen complementos a todos cuentas de un dominio o a unidades organizativas o grupos de acceso específicos. Solo un administrador de dominio puede realizar la instalación de un administrador. El de forma opcional, el administrador puede dar su consentimiento para todos los permisos de acceso en nombre de todos los usuarios en el dominio; a los usuarios no se les solicita que den su consentimiento para ningún permiso de acceso si el 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 licencias. Si tu aplicación requiere una licencia, canalizar las instalaciones a través de un administrador podría garantizar las licencias se distribuyen y se usan adecuadamente con las institución educativa.
• Menor carga para los usuarios finales. La instalación de un administrador reduce para profesores y estudiantes. Esto podría dar como resultado una experiencia de usuario experiencia con menos clics y menos oportunidades de confusión.

Consulta Instala aplicaciones 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. El usuario se le solicitará que otorgue su consentimiento para 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 la Google Workspace Marketplace Si permites la instalación individual, es posible que se te solicite más profesores para que adopten o aboguen por tu producto.
• Pruebas de administrador. Un administrador puede instalar individualmente un complementario para probarlo o evaluarlo antes de aprobarlo o instalarlo para una grupo más amplio.

Además de instalar complementos en nombre de los usuarios, los administradores pueden mantener una lista de entidades permitidas para permitir que los usuarios instalen complementos que permitan a usuarios individuales instalación. Si un complemento no se encuentra en la lista de entidades permitidas, los usuarios aún podrán ver el del complemento en Google Workspace Marketplace, pero no se puede instalar el complemento; ve un mensaje que explica que el complemento no se usó un administrador de dominio puede instalar. Consulta Administra Google Workspace Marketplace en tu lista de entidades permitidas para obtener más información sobre este comportamiento.

Consulta la documentación de la 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 archivo adjunto. Esta La URL se usa como el valor src del iframe para el iframe de descubrimiento de archivos adjuntos. El Los profesores usan el iframe de descubrimiento de archivos adjuntos para encontrar contenido o actividades para lo siguiente: adjuntar a su tarea.

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

Para obtener más información sobre estos campos, consulta la página de la guía de iframes.

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 alumno para probar el cambio entre a los estudiantes en el iframe de revisión de trabajos de los estudiantes.

Cuentas de prueba sugeridas:

• Profesora Tamara, profesora.maria@<tu dominio de demostración>
• Sam Student, sam.student@<tu dominio de demostración>
• Sally, estudiante, sally.student@<tu dominio de demostración>

Sigue este procedimiento para crear una cuenta de prueba nueva:

1. Accede a la Consola del administrador.
2. Navega a Usuarios.
3. Haz clic en Agregar un nuevo usuario (consulta la Figura 1).
4. Ingresa la información del usuario y asigna las funciones adecuadas.

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

Sigue este procedimiento para crear un grupo de prueba nuevo:

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 los propietarios del grupo.

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