Requisitos de los complementos

Versión 1.1, 5 de diciembre de 2024.

Los criterios de esta página se aplican a todos los complementos de Classroom. Tu complemento debe cumplir con todos los elementos obligatorios aplicables para que se apruebe su inclusión en Google Workspace Marketplace y para que sea un complemento que "Funcione con Classroom".

Las palabras clave “DEBE”, “NO DEBE”, “OBLIGATORIO”, “DEBERÁ”, “NO DEBERÁ”, “DEBERÍA”, “NO DEBERÍA”, “RECOMENDADO”, “PUEDE” y “OPCIONAL” que se utilizan en este documento se deben interpretar como se describe en RFC 2119.

Requisitos

ID Tipo
1.0 Licencia de usuario final (si corresponde)
  1.1 Se DEBE mostrar un mensaje fácil de entender al usuario cuando no tenga una licencia. El mensaje DEBE indicar claramente el motivo por el que no se puede usar el complemento y sugerirle al usuario un curso de acción para remediar la situación. OPCIÓN RECOMENDADA
  1.3 La ficha del complemento en Google Workspace Marketplace DEBE especificar detalles sobre los requisitos de licencia y suscripción que pueden ser necesarios para usar el complemento. Si el complemento tiene un nivel pagado, la ficha de Marketplace 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 del usuario final
  2.1 Los usuarios docentes 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 acceder automáticamente a la cuenta de un usuario en visitas posteriores sin mostrar un mensaje de acceso.
Cuando la sugerencia de acceso no produce una coincidencia con el usuario que accedió actualmente, el complemento DEBE mostrarle al usuario un botón de acceso y pasar el parámetro 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 (según la sugerencia de acceso), el complemento DEBE mostrar un botón "Acceder con Google" para que el usuario realice una acción explícita que 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 actualmente 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 SOLO DEBE completar el recorrido con un flujo de trabajo de complemento y no cambiar a un flujo de trabajo de CourseWork ni usar el botón para compartir en Classroom. REQUIRED
  3.4 Opción de localización: El idioma DEBE basarse en la preferencia local establecida por 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 del trabajo del estudiante. REQUIRED
  3.9 Los complementos DEBEN cumplir con los lineamientos de accesibilidad de nivel AA de los WCAG 2.1. Los desarrolladores de complementos informarán por su cuenta que se cumple con este requisito en el momento del envío y que el complemento seguirá cumpliendo con los cambios futuros que se realicen en él. OPCIÓN RECOMENDADA
  3.10 CUALQUIER error que experimente un usuario DEBE ser legible. OPCIÓN RECOMENDADA
  3.11 Si studentViewUri, teacherViewUri o studentWorkViewUri se inician 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 adjunto requiere que el estudiante envíe una respuesta, DEBE incluir un studentWorkReviewUri para que se considere un tipo de actividad y no un tipo de contenido adjunto. REQUIRED
  4.2 El iframe de Attachment Discovery DEBE proporcionar una interfaz de usuario que ofrezca, al menos, una de las siguientes opciones:
  • Crea contenido nuevo para adjuntarlo
  • Explorar, seleccionar y adjuntar contenido de una biblioteca
  • 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 y 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 adjuntarlos a la tarea. OPCIÓN RECOMENDADA
  4.5 Si el profesor debe realizar trabajo para crear contenido o actividades antes de que se puedan adjuntar, ese trabajo SE DEBE completar en el iframe. OPCIÓN RECOMENDADA
5.0 Vista del estudiante
  5.1 Cuando se inicie el complemento studentViewUri, NO se 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 una actividad del complemento aparece fuera del 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 Entregar 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 verá el estudiante 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 del estudiante para que el profesor lo revise dentro del iframe. Es posible que el material complementario tenga vínculos fuera del iframe. REQUIRED
  7.2 El complemento NO DEBE habilitar la navegación entre los estudiantes en la vista studentWorkReviewUri. La navegación entre estudiantes SOLO debe realizarse en la IU de Classroom. REQUIRED
8.0 Compatibilidad con dispositivos móviles de Classroom
  8.1 Cuando la app de Classroom para dispositivos móviles lanza un teacherViewUri, studentViewUri o studentWorkReviewUri, la URL DEBE abrir la app nativa para dispositivos móviles del socio o la app web para dispositivos móviles del socio y, en ambos casos, vincular directamente 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 ser posible, qué dispositivos sí lo son. 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 desde 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 reformuló. Un cambio reciente permite que los desarrolladores de complementos entreguen de forma confiable los trabajos de los estudiantes con la API.
Versión 1.0 Actualizado el 30 de abril de 2024
1.1 Se combinaron los requisitos 1.1 y 1.2 en uno solo.
2.1 Se combinaron los puntos 2.1 y 2.5 en un solo requisito.
2.2 Se combinaron los requisitos 2.2, 2.3 y 2.4 en uno solo.
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 las versiones 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 de Descubrimiento de adjuntos aceptables.
4.3 Se renumeró. Antes era el 4.2. También se cambió de REQUIRED a RECOMMENDED.
4.4 Se renumeró. Antes era el 4.3.
4.5 Se volvió a numerar. Antes era el 4.4.
5.2 Se renumeró. Anteriormente, era el 5.3.
5.3 Se renumeró. Anteriormente, era el 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 manera programática.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Se quitó el elemento.
Versión 0.3 Actualizado el 22 de noviembre de 2022
2.3 Se corrigió la orientación sobre la sugerencia 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 ruta".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Se agregó orientación obligatoria y recomendada para la copia de cursos en studentViewUri, teacherViewUri y studentWorkReviewUri.
Versión 0.2 Actualizado el 29 de octubre de 2021
1.3 Se modificó el texto para que la intención sea más clara.
3.1 Se agregó la siguiente oración: "El complemento DEBE cumplir con los lineamientos generales de aprobación de GWM que se encuentran en su sitio web".
3.9 Las WCAG cambiaron el estado de OBLIGATORIO a RECOMENDADO.
5.1 Se cambió de OBLIGATORIO a RECOMENDADO.
5.3 Se agregó la siguiente oración: "Si los complementos aparecen fuera del iframe, DEBE haber una vista previa sobre la tarea en el iframe".
5.4 Se agregó la siguiente oración: "Si el complemento sale del iframe, DEBE haber un mensaje para que los estudiantes vuelvan a Classroom".
8.1 Se agregó la siguiente oración: "Si el dispositivo no es compatible, se DEBE mostrar un mensaje al usuario para informarle que se trata de un dispositivo no compatible y, de ser posible, qué dispositivos son compatibles".
8.2 El trabajo de los estudiantes en dispositivos móviles cambió de REQUIRED a RECOMMENDED.
Versión 0.1 Actualizado el 22 de septiembre de 2021
  Versión inicial