Requisiti per i componenti aggiuntivi

Versione 1.1, 5 dicembre 2024.

I criteri in questa pagina si applicano a tutti i componenti aggiuntivi di Classroom. Il componente aggiuntivo deve soddisfare tutti gli elementi obbligatori applicabili per essere approvato per la scheda in Google Workspace Marketplace e per essere considerato un componente aggiuntivo "Funziona con Classroom".

Le parole chiave "DEVE", "DEVONO", "NON DEVE", "NON DEVONO", "OBBLIGATORIO", "OBBLIGATORI", "DOVREBBE", "DOVREBBERO", "NON DOVREBBE", "NON DOVREBBERO", "CONSIGLIATO", "CONSIGLIATI", "POTREBBE", "POTREBBERO", "FACOLTATIVO", "FACOLTATIVI" nel presente documento devono essere interpretate come descritto nel documento RFC 2119.

Requisiti

ID Tipo
1.0 Licenza dell'utente finale (se applicabile)
  1.1 All'utente DOVREBBE essere mostrato un messaggio di facile comprensione quando non ha una licenza. Il messaggio DOVREBBE indicare chiaramente il motivo per cui il componente aggiuntivo non può essere utilizzato e suggerire all'utente una linea di condotta per risolvere la situazione. CONSIGLIATO
  1.3 La scheda di Google Workspace Marketplace per il componente aggiuntivo DOVREBBE specificare i dettagli sui requisiti di licenza e abbonamento che potrebbero essere necessari per utilizzare il componente aggiuntivo. Se il componente aggiuntivo ha un livello a pagamento, la scheda di Marketplace DOVREBBE fornire un link a una pagina web che offre ulteriori informazioni sui prezzi o su come contattare un venditore. CONSIGLIATO
2.0 Accesso dell'utente finale
  2.1 Gli utenti insegnanti DEVONO accedere al componente aggiuntivo utilizzando il servizio SSO di Google.
Se agli studenti viene chiesto di accedere al componente aggiuntivo, DEVONO accedere utilizzando il servizio SSO di Google.		 OBBLIGATORIO
  2.2 Il componente aggiuntivo DEVE utilizzare il servizio SSO di Google per consentire a un utente di accedere automaticamente nelle visite successive senza mostrare una richiesta di accesso.
Quando il suggerimento di accesso non produce una corrispondenza con l'utente che ha eseguito l'accesso, il componente aggiuntivo DEVE richiedere all'utente di accedere con un pulsante di accesso e passare il parametro login_hint alla libreria di autenticazione per filtrare gli account non validi.		 OBBLIGATORIO
  2.7 Quando l'utente di Classroom non ha ancora eseguito l'accesso al componente aggiuntivo (come determinato dal suggerimento di accesso), il componente aggiuntivo DEVE presentare un pulsante 'Accedi con Google' per consentire all'utente di avviare esplicitamente la procedura di accesso.
Nota: questa operazione è necessaria per soddisfare le linee guida per il branding di Google e aiuta anche a evitare i blocco popup.		 OBBLIGATORIO
  2.8 Il componente aggiuntivo DOVREBBE mostrare l'utente che ha eseguito l'accesso. CONSIGLIATO
3.0 Generali
  3.1 Il componente aggiuntivo DEVE rispettare le linee guida generali per l'approvazione di Google Workspace Marketplace. OBBLIGATORIO
  3.2 Se un'attività viene avviata in una nuova scheda o finestra da uno dei percorsi iframe, DOVREBBE fornire un messaggio di facile comprensione per tornare a Classroom. CONSIGLIATO
  3.3 L'utente DEVE completare il percorso utilizzando solo un flusso di lavoro del componente aggiuntivo e non passare a un flusso di lavoro di CourseWork o utilizzare il pulsante di condivisione di Classroom. OBBLIGATORIO
  3.4 Scelta della localizzazione: la lingua DOVREBBE basarsi sulle preferenze locali impostate dal browser, se disponibili. CONSIGLIATO
  3.5 Se un componente aggiuntivo definisce maxPoints, DEVE anche impostare pointsEarned quando uno studente completa un invio utilizzando le credenziali dell'insegnante memorizzate (opzione consigliata) OPPURE quando l'insegnante apre l'invio nell'iframe di revisione dei lavori degli studenti. OBBLIGATORIO
  3.9 I componenti aggiuntivi DOVREBBERO essere conformi alle linee guida WCAG 2.1 di livello AA sull'accessibilità. Gli sviluppatori di componenti aggiuntivi dichiareranno autonomamente che questo requisito è soddisfatto al momento dell'invio e che il componente aggiuntivo continuerà a essere conforme alle modifiche future. CONSIGLIATO
  3.10 Eventuali errori riscontrati da un utente DOVREBBERO essere leggibili. CONSIGLIATO
  3.11 Se studentViewUri, teacherViewUri o studentWorkViewUri viene avviato da un compito o da un corso copiato, il componente aggiuntivo NON DEVE visualizzare una pagina di errore nell'iframe. OBBLIGATORIO
4.0 Rilevamento degli allegati
  4.1 Se un allegato richiede l'invio di uno studente, DEVE includere un studentWorkReviewUri in modo che venga trattato come un tipo di attività e non come un allegato di tipo di contenuti. OBBLIGATORIO
  4.2 L'iframe di rilevamento degli allegati DEVE fornire un'interfaccia utente che offra almeno una delle seguenti opzioni:
  • Crea nuovi contenuti da allegare
  • Sfoglia, seleziona e allega da una raccolta di contenuti
  • Istruzioni per allegare contenuti dal tuo sito web o da altri prodotti
 OBBLIGATORIO
  4.3 L'insegnante DOVREBBE essere in grado di trovare e accedere a tutti i contenuti/le attività a sua disposizione. CONSIGLIATO
  4.4 L'insegnante DOVREBBE essere in grado di visualizzare l'anteprima dei contenuti/dell'attività prima di impegnarsi ad allegarli al compito. CONSIGLIATO
  4.5 Se l'insegnante deve creare contenuti/attività prima di poterli allegare, questa operazione DOVREBBE essere completata nell'iframe. CONSIGLIATO
5.0 Visualizzazione dello studente
  5.1 Quando viene avviato studentViewUri, il componente aggiuntivo NON DOVREBBE estrarre l'utente dall'iframe per completare un'attività.
Se il componente aggiuntivo estrae l'utente dall'iframe, DEVE essere presente un messaggio o un'altra indicazione per gli studenti per tornare a Classroom.		 CONSIGLIATO
  5.2 Se un'attività del componente aggiuntivo viene estratta dall'iframe, DOVREBBE essere presente un'anteprima dell'attività nell'iframe. CONSIGLIATO
  5.3 Se presente, un pulsante o un link nell'attività con l'etichetta Consegna DEVE causare una richiesta API per inviare il lavoro dello studente per la revisione dell'insegnante. OBBLIGATORIO
6.0 Visualizzazione dell'insegnante
  6.1 L'insegnante DOVREBBE essere in grado di vedere cosa vedrà lo studente quando svolgerà il compito. CONSIGLIATO
7.0 Revisione dei lavori degli studenti
  7.1 Se viene avviato studentWorkReviewUri, il componente aggiuntivo DEVE eseguire il rendering del lavoro dello studente per la revisione dell'insegnante all'interno dell'iframe. Il materiale supplementare può rimandare a contenuti esterni all'iframe. OBBLIGATORIO
  7.2 Il componente aggiuntivo NON DEVE consentire la navigazione tra gli studenti nella visualizzazione studentWorkReviewUri. La navigazione tra gli studenti DEVE avvenire solo nell'interfaccia utente di Classroom. OBBLIGATORIO
8.0 Supporto per l'app mobile Classroom
  8.1 Quando l'app mobile Classroom avvia un teacherViewUri, studentViewUri o studentWorkReviewUri, l'URL DEVE aprire l'app nativa mobile del partner o l'app web mobile del partner e, in entrambi i casi, il deep link alla visualizzazione corretta. Se il dispositivo non è supportato, all'utente DEVE essere visualizzato un messaggio che lo informa che si tratta di un dispositivo non supportato e, idealmente, quali dispositivi sono supportati. OBBLIGATORIO
  8.2 Il lavoro degli studenti DOVREBBE essere completato su un dispositivo mobile. CONSIGLIATO
9.0 Altre funzionalità
  9.1 Se gli insegnanti possono incollare link ai tuoi contenuti come allegati di link, DOVRESTI eseguire l'upgrade dei link a allegati di componenti aggiuntivi. CONSIGLIATO
  9.2 Se utilizzi un'integrazione di CourseWork per creare compiti al di fuori di Classroom, DOVRESTI creare allegati di componenti aggiuntivi per impostazione predefinita per tutti i link compatibili con il tuo componente aggiuntivo. CONSIGLIATO

Log delle modifiche

Versione 1.1 Aggiornato il 5 dicembre 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Modificato da OBBLIGATORIO a CONSIGLIATO.
3.12 Rimosso.
5.3 Modificato. Una recente modifica consente agli sviluppatori di componenti aggiuntivi di consegnare in modo affidabile i contenuti inviati dagli studenti utilizzando l'API.
Versione 1.0 Aggiornato il 30 aprile 2024
1.1 I requisiti 1.1 e 1.2 sono stati combinati in un unico requisito.
2.1 I requisiti 2.1 e 2.5 sono stati combinati in un unico requisito.
2.2 I requisiti 2.2, 2.3 e 2.4 sono stati combinati in un unico requisito.
3.5 I requisiti 3.5, 3.6 e 3.7 sono stati combinati in un unico requisito.
3.10 È stato aggiunto il requisito che il componente aggiuntivo non entri mai in uno stato incomprensibile o irrecuperabile.
3.11, 3.12 I requisiti 5.5, 5.6, 6.3, 6.4, 7.5 e 7.6 sono stati combinati in due nuovi requisiti.
4.2 È stata ampliata la descrizione delle esperienze di rilevamento degli allegati accettabili.
4.3 Rinumerato, in precedenza 4.2. Modificato anche da OBBLIGATORIO a CONSIGLIATO.
4.4 Rinumerato, in precedenza 4.3.
4.5 Rinumerato, in precedenza 4.4.
5.2 Rinumerato, in precedenza 5.3.
5.3 Rinumerato, in precedenza 5.2.
9.1 È stato aggiunto un consiglio per eseguire l'upgrade dei link incollati agli allegati.
9.2 È stato aggiunto un consiglio per creare allegati di componenti aggiuntivi per impostazione predefinita quando si creano compiti di CourseWork a livello di programmazione.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Rimossi.
Versione 0.3 Aggiornato il 22 novembre 2022
2.3 Correzione delle indicazioni relative al suggerimento di accesso.
2.4 È stato incorporato uno scenario in cui è necessario implementare hd è richiesto.
3.2 È stato modificato il testo "provide path".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Sono state aggiunte indicazioni obbligatorie e consigliate per la copia del corso per studentViewUri, teacherViewUri e studentWorkReviewUri.
Versione 0.2 Aggiornato il 29 ottobre 2021
1.3 Il testo è stato modificato per chiarire meglio l'intento.
3.1 È stato aggiunto il testo "Il componente aggiuntivo DEVE rispettare le linee guida generali per l'approvazione di GWM disponibili sul sito web".
3.9 WCAG è stato modificato da OBBLIGATORIO a CONSIGLIATO.
5.1 Modificato da OBBLIGATORIO a CONSIGLIATO.
5.3 È stato aggiunto il testo "Se il componente aggiuntivo viene estratto dall'iframe, DEVE essere presente un'anteprima dell'attività nell'iframe".
5.4 È stato aggiunto il testo "Se il componente aggiuntivo viene estratto dall'iframe, DOVREBBE essere presente una richiesta per gli studenti di tornare a Classroom".
8.1 È stato aggiunto il testo "Se il dispositivo non è supportato, all'utente DEVE essere visualizzato un messaggio che lo informa che si tratta di un dispositivo non supportato e, idealmente, quali dispositivi sono supportati".
8.2 Il lavoro degli studenti su dispositivo mobile è stato modificato da OBBLIGATORIO a CONSIGLIATO.
Versione 0.1 Aggiornato il 22 settembre 2021
  Release iniziale.