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 publicación en Google Workspace Marketplace y 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" de este documento se deben interpretar como se describe en RFC 2119.

Requisitos

ID Tipo
1.0 Licencia para el usuario final (si corresponde)
  1.1 Se DEBERÍA mostrar un mensaje fácil de usar al usuario cuando no tenga una licencia. El mensaje DEBERÍA 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 para el complemento DEBERÍA 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 DEBERÍA 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**profesores** DEBEN acceder al complemento con el SSO de Google.
Si se les pide 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 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 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 (según se determina mirando 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 marca de Google y también ayuda a evitar los bloqueadores de ventanas emergentes.		 REQUIRED
  2.8 El complemento DEBERÍA mostrar quién es el usuario que accedió actualmente. 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, DEBERÍA 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 complementos y no cambiar a un flujo de trabajo de CourseWork ni usar el botón Compartir de Classroom. REQUIRED
  3.4 Opción de localización: El idioma DEBERÍA 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 Student Work Review. REQUIRED
  3.9 Los complementos DEBERÍAN cumplir con los lineamientos de accesibilidad de nivel AA de WCAG 2.1. Los desarrolladores de complementos informarán por sí mismos que se cumple con este requisito en el momento del envío y que el complemento sigue cumpliendo con los cambios futuros del complemento. OPCIÓN RECOMENDADA
  3.10 Los errores que experimente un usuario DEBERÍAN ser legibles. 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 una entrega del estudiante, el archivo adjunto DEBE incluir un studentWorkReviewUri para que se trate como un tipo de actividad y no como un tipo de contenido. REQUIRED
  4.2 El iframe de Attachment Discovery DEBE proporcionar una interfaz de usuario que ofrezca al menos una de las siguientes opciones:
  • Crear contenido nuevo para adjuntar
  • Explorar, seleccionar y adjuntar desde una biblioteca de contenido
  • Instrucciones para adjuntar contenido desde tu sitio web o de otros productos
 REQUIRED
  4.3 El profesor DEBERÍA poder encontrar y acceder a todo el contenido o las actividades disponibles para él. OPCIÓN RECOMENDADA
  4.4 El profesor DEBERÍA 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 trabajar para crear contenido o una actividad antes de que se pueda adjuntar, ese trabajo DEBERÍA completarse en el iframe. OPCIÓN RECOMENDADA
5.0 Vista del estudiante
  5.1 Cuando se inicia studentViewUri, el complemento NO DEBERÍA 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 vuelvan a Classroom.		 OPCIÓN RECOMENDADA
  5.2 Si una actividad de complemento sale del iframe, DEBERÍA haber una vista previa sobre la tarea en el iframe. OPCIÓN RECOMENDADA
  5.3 Si está presente, un botón o vínculo en la actividad etiquetada como Entregar DEBE provocar 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 DEBERÍA poder ver lo que verá el estudiante cuando haga la tarea. OPCIÓN RECOMENDADA
7.0 Revisión del trabajo del estudiante
  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 con dispositivos móviles de Classroom
  8.1 Cuando la app para dispositivos móviles de Classroom inicia un teacherViewUri, studentViewUri o studentWorkReviewUri, la URL DEBE abrir la aplicación nativa para dispositivos móviles del socio o la app web para dispositivos móviles del socio y, en cualquier caso, vincularse 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 manera ideal, qué dispositivos sí lo son. REQUIRED
  8.2 El trabajo del estudiante DEBERÍA 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, DEBERÍAS 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, DEBERÍAS crear archivos 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 REQUIRED a OPCIÓN RECOMENDADA.
3.12 Se quitó el elemento.
5.3 Se modificó la redacción. Un cambio reciente permite que los desarrolladores de complementos entreguen de forma confiable las entregas de los estudiantes con la API.
Versión 1.0 Actualizado el 30 de abril de 2024
1.1 Se combinaron 1.1 y 1.2 en un solo requisito.
2.1 Se combinaron 2.1 y 2.5 en un solo requisito.
2.2 Se combinaron 2.2, 2.3 y 2.4 en un solo requisito.
3.5 Se combinaron 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 ininteligible o irrecuperable.
3.11, 3.12 Se combinaron 5.5, 5.6, 6.3, 6.4, 7.5 y 7.6 en dos requisitos nuevos
4.2 Se amplió la descripción de las experiencias aceptables de Attachment Discovery.
4.3 Se volvió a numerar, antes era 4.2. También se cambió de REQUIRED a OPCIÓN RECOMENDADA.
4.4 Se volvió a numerar, antes era 4.3.
4.5 Se volvió a numerar, antes era 4.4.
5.2 Se volvió a numerar, antes era 5.3.
5.3 Se volvió a numerar, 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 Actualizado el 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 es requerido.
3.2 Se modificó la redacción de "proporcionar ruta de acceso".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Se agregó la guía obligatoria y recomendada para la copia del curso para el 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ó "El complemento DEBE cumplir con los lineamientos generales de aprobación de GWM que se encuentran en su sitio web".
3.9 WCAG cambió REQUIRED a OPCIÓN RECOMENDADA.
5.1 Se cambió REQUIRED a OPCIÓN RECOMENDADA.
5.3 Se agregó "Si el complemento sale del iframe, DEBE haber una vista previa sobre la tarea en el iframe."
5.4 Se agregó "Si el complemento sale del iframe, DEBERÍA haber un mensaje para que los estudiantes vuelvan a Classroom."
8.1 Se agregó "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 sí lo son."
8.2 El trabajo del estudiante en dispositivos móviles cambió de REQUIRED a OPCIÓN RECOMENDADA.
Versión 0.1 Actualizado el 22 de septiembre de 2021
  Versión inicial