Requisitos de los complementos

Versión 1.0, 30 de abril de 2024

Los criterios que se indican en esta página se aplican a todos los complementos de Classroom. Tu complemento debe cumplir con todos los elementos obligatorios correspondientes para que se apruebe su publicación en Google Workspace Marketplace y ser un complemento que “Funciona con Classroom”.

Las palabras clave “DEBER”, “NO DEBER”, “OBLIGATORIO”, “DEBEN”, “NO DEBEN”, “DEBEN”, “NO DEBEN”, “RECOMENDADO”, “PUEDEN” y “OPCIONAL” en este documento se deben interpretar como se describe en la RFC 2119.

Requisitos

ID Tipo
1.0 Licencia de usuario final (si corresponde)
  1.1 DEBE mostrarse un mensaje fácil de entender cuando el usuario no tiene una licencia. El mensaje DEBE indicar claramente el motivo por el que no se puede usar el complemento y sugerir un curso de acción para que el usuario solucione la situación. OPCIÓN RECOMENDADA
  1.3 La ficha de Google Workspace Marketplace del complemento DEBE especificar detalles sobre los requisitos de licencia y suscripción que pueden ser necesarios para usarlo. Si el complemento tiene un nivel pagado, la ficha del mercado DEBE proporcionar un vínculo a una página web que ofrezca más información sobre los precios o cómo comunicarse con un vendedor. OPCIÓN RECOMENDADA
2.0 Acceso de usuarios finales
  2.1 Los usuarios profesores DEBEN acceder al complemento con el SSO de Google.
Si se les solicita a los usuarios estudiantes que accedan al complemento, DEBEN hacerlo con el SSO de Google.
REQUIRED
  2.2 El complemento DEBE usar el SSO de Google para que un usuario acceda automáticamente en visitas posteriores sin mostrar un mensaje de acceso.
Cuando la sugerencia de acceso no coincide con el usuario que accedió actualmente, el complemento DEBE solicitarle al usuario un botón de acceso y pasar el login_hint a la biblioteca de autenticación para filtrar las cuentas no válidas.
REQUIRED
  2.7 Cuando el usuario de Classroom aún no accedió al complemento (como se determina al observar la sugerencia de acceso), el complemento DEBE presentar un botón "Acceder con Google" para que la acción explícita del usuario active el proceso de acceso.
Nota: Esto es necesario para cumplir con los lineamientos de desarrollo de la marca de Google y también ayuda a evitar los bloqueadores de ventanas emergentes.
REQUIRED
  2.8 El complemento DEBE mostrar quién es el usuario que accedió. OPCIÓN RECOMENDADA
3.0 General
  3.1 El complemento DEBE cumplir con los lineamientos generales de aprobación de Google Workspace Marketplace. REQUIRED
  3.2 Si se inicia una tarea en una pestaña o ventana nueva desde cualquiera de los recorridos de iframe, DEBE proporcionar un mensaje fácil de usar para volver a Classroom. OPCIÓN RECOMENDADA
  3.3 El usuario DEBE completar el recorrido solo con un flujo de trabajo de complementos y no cambiar a un flujo de trabajo de Coursework ni usar el botón de Compartir de Classroom. REQUIRED
  3.4 Elección de localización: El idioma DEBE basarse en la preferencia local que establece el navegador cuando está disponible. OPCIÓN RECOMENDADA
  3.5 Si un complemento define maxPoints, también DEBE establecer pointsEarned cuando un estudiante completa una entrega con credenciales de profesor almacenadas (recomendado) O cuando el profesor abre la entrega en el iframe de Revisión de trabajos de estudiantes. REQUIRED
  3.9 Los complementos DEBEN cumplir con los lineamientos de accesibilidad de nivel AA de los WCAG 2.1. Los desarrolladores de complementos deberán autoinformar que se cumple con este requisito en el momento del envío y que el complemento seguirá cumpliendo con los cambios futuros. OPCIÓN RECOMENDADA
  3.10 Cualquier error que experimente un usuario DEBE ser legible por humanos. OPCIÓN RECOMENDADA
  3.11 Si se inicia studentViewUri, teacherViewUri o studentWorkViewUri desde una tarea o un curso copiados, el complemento NO DEBE mostrar una página de error en el iframe. REQUIRED
4.0 Descubrimiento de archivos adjuntos
  4.1 Si un archivo adjunto requiere que el estudiante lo envíe, DEBE incluir un studentWorkReviewUri para que se trate como un tipo de actividad y no como un archivo adjunto de tipo de contenido. REQUIRED
  4.2 El iframe de descubrimiento de archivos adjuntos DEBE proporcionar una interfaz de usuario que ofrezca, al menos, una de las siguientes opciones:
  • Crea contenido nuevo para adjuntarlo
  • Explorar, seleccionar y adjuntar desde una biblioteca de contenido
  • Instrucciones para adjuntar contenido de tu sitio web o de otros productos
REQUIRED
  4.3 El profesor DEBE poder encontrar y acceder a todo el contenido o las actividades disponibles para él. OPCIÓN RECOMENDADA
  4.4 El profesor DEBE poder obtener una vista previa del contenido o la actividad antes de comprometerse a adjuntarlo a la tarea. OPCIÓN RECOMENDADA
  4.5 Si el profesor debe realizar tareas para crear contenido o actividades antes de que se puedan adjuntar, esas tareas DEBEN completarse en el iframe. OPCIÓN RECOMENDADA
5.0 Vista del estudiante
  5.1 Cuando se inicia studentViewUri, el complemento NO DEBE sacar al usuario del iframe para completar una tarea.
Si el complemento saca al usuario del iframe, DEBE haber un mensaje o alguna otra indicación para que los estudiantes regresen a Classroom.
OPCIÓN RECOMENDADA
  5.2 Si aparece una actividad del complemento en el iframe, DEBE haber una vista previa de la tarea en el iframe. OPCIÓN RECOMENDADA
  5.3 Si está presente, un botón o vínculo en la actividad etiquetado como Enviar DEBE generar una solicitud a la API para enviar el trabajo del estudiante para que el profesor lo revise. REQUIRED
6.0 Vista del profesor
  6.1 El profesor DEBE poder ver lo que el estudiante verá cuando realice la tarea. OPCIÓN RECOMENDADA
7.0 Revisión del trabajo de los estudiantes
  7.1 Si se inicia studentWorkReviewUri, el complemento DEBE renderizar el trabajo de ese estudiante para que el profesor lo revise dentro del iframe. El material complementario puede vincularse fuera del iframe. REQUIRED
  7.2 El complemento NO DEBE habilitar la navegación entre estudiantes en la vista studentWorkReviewUri. La navegación entre estudiantes DEBE realizarse solo en la IU de Classroom. REQUIRED
8.0 Compatibilidad de Classroom con dispositivos móviles
  8.1 Cuando la app de Classroom para dispositivos móviles inicia un teacherViewUri, studentViewUri o studentWorkReviewUri, la URL DEBE abrir la app nativa para dispositivos móviles o la app web para dispositivos móviles del socio y, en cualquier caso, establecer un vínculo directo a la vista correcta. Si el dispositivo no es compatible, SE DEBE mostrar un mensaje al usuario para informarle que no es compatible y, de manera ideal, qué dispositivos son compatibles. REQUIRED
  8.2 El trabajo de los estudiantes DEBE poder completarse en un dispositivo móvil. OPCIÓN RECOMENDADA
9.0 Funciones adicionales
  9.1 Si los profesores pueden pegar vínculos a tu contenido como archivos adjuntos de vínculos, DEBES actualizar los vínculos a archivos adjuntos de complementos. OPCIÓN RECOMENDADA
  9.2 Si usas una integración de CourseWork para crear tareas fuera de Classroom, DEBES crear adjuntos de complementos de forma predeterminada para todos los vínculos compatibles con tu complemento. OPCIÓN RECOMENDADA

Registro de cambios

Versión 1.1 Actualizado el 5 de diciembre de 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Se cambió de OBLIGATORIO a RECOMENDADO.
3.12 Se quitó el elemento.
5.3 Se cambió la redacción. Un cambio reciente permite que los desarrolladores de complementos entreguen trabajos de los estudiantes de forma confiable con la API.
Versión 1.0 Actualizado el 30 de abril de 2024
1.1 Se combinaron los artículos 1.1 y 1.2 en un solo requisito.
2.1 Se combinaron los artículos 2.1 y 2.5 en un solo requisito.
2.2 Se combinaron los artículos 2.2, 2.3 y 2.4 en un solo requisito.
3.5 Se combinaron las versiones 3.5, 3.6 y 3.7 en un solo requisito.
3.10 Se agregó el requisito de que el complemento nunca entre en un estado incomprensible o irrecuperable.
3.11 y 3.12 Se combinaron los artículos 5.5, 5.6, 6.3, 6.4, 7.5 y 7.6 en dos requisitos nuevos.
4.2 Se expandió la descripción de las experiencias aceptables de descubrimiento de archivos adjuntos.
4.3 Se cambió el número de versión, antes era 4.2. También se cambió de OBLIGATORIO a RECOMENDADO.
4.4 Se cambió el número de artículo, antes era 4.3.
4.5 Se cambió el número de versión, antes era 4.4.
5.2 Se cambió el número de artículo, antes era 5.3.
5.3 Se cambió el número de versión, antes era 5.2.
9.1 Se agregó una recomendación para actualizar los vínculos pegados a archivos adjuntos.
9.2 Se agregó una recomendación para crear archivos adjuntos de complementos de forma predeterminada cuando se crean tareas de CourseWork de forma programática.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Se quitó el elemento.
Versión 0.3 Fecha de actualización: 22 de noviembre de 2022
2.3 Corrección de la guía de sugerencias de acceso
2.4 Se incorporó una situación en la que se requiere implementar hd.
3.2 Se modificó la redacción de "proporcionar una ruta".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Se agregó la orientación obligatoria y recomendada para el texto del curso para studentViewUri, teacherViewUri y studentWorkReviewUri.
Versión 0.2 Actualizado el 29 de oct de 2021
1.3 Se modificó el texto para que el propósito sea más claro.
3.1 Se agregó el siguiente texto: "El complemento DEBE cumplir con los lineamientos generales de aprobación de GWM que se encuentran en su sitio web".
3.9 El WCAG cambió de OBLIGATORIO a RECOMENDADO.
5.1 Se cambió el valor de OBLIGATORIO a RECOMENDADO.
5.3 Se agregó "Si los complementos aparecen fuera del iframe, DEBEN tener una vista previa de la tarea en el iframe".
5.4 Se agregó el siguiente texto: “Si el complemento aparece fuera del iframe, DEBE haber un mensaje para que los estudiantes regresen a Classroom”.
8.1 Se agregó el siguiente texto: "Si el dispositivo no es compatible, DEBE mostrarse un mensaje al usuario para informarle que no es compatible y, de manera ideal, qué dispositivos son compatibles".
8.2 El trabajo de los estudiantes en dispositivos móviles cambió de OBLIGATORIO a RECOMENDADO.
Versión 0.1 Actualizado el 22 de septiembre de 2021
  Versión inicial