Requisiti per i componenti aggiuntivi

Versione 1.0, 30 aprile 2024.

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

Le parole chiave "DEVE", "NON DEVE", "OBBLIGATORIO", "DEVE", "NON DEVE", "DEVE", "NON DEVE", "CONSIGLIATO", "PUÒ" e "FACOLTATIVO" in questo documento devono essere interpretate come descritto nella RFC 2119.

Requisiti

ID Tipo
1.0 Licenza dell'utente finale (se applicabile)
  1.1 È necessario mostrare un messaggio di facile comprensione all'utente quando non dispone di una licenza. Il messaggio DEVE indicare chiaramente il motivo per cui non è possibile utilizzare il componente aggiuntivo e suggerire all'utente una linea di condotta per risolvere la situazione. CONSIGLIATA
  1.3 La scheda di Google Workspace Marketplace del componente aggiuntivo DEVE specificare i dettagli sui requisiti di licenza e abbonamento che potrebbero essere necessari per utilizzarlo. Se il componente aggiuntivo ha un livello a pagamento, la scheda del marketplace DEVE fornire un link a una pagina web che offra ulteriori informazioni sui prezzi o su come contattare un addetto alle vendite. CONSIGLIATA
2.0 Accesso utente finale
  2.1 Gli utenti insegnanti DEVONO accedere al componente aggiuntivo utilizzando l'accesso SSO di Google.
Se agli utenti studenti viene chiesto di accedere al componente aggiuntivo, DEVONO farlo utilizzando l'accesso SSO di Google.
OBBLIGATORIO
  2.2 Il componente aggiuntivo DEVE utilizzare l'accesso SSO di Google per far accedere automaticamente un utente alle visite successive senza mostrare una richiesta di accesso.
Quando l'indizio di accesso non genera una corrispondenza con l'utente che ha eseguito l'accesso, il componente aggiuntivo DEVE mostrare all'utente un pulsante di accesso e passare il parametro login_hint alla libreria di autenticazione per filtrare gli account non validi.
OBBLIGATORIO
  2,7 Se l'utente di Classroom non ha ancora eseguito l'accesso al componente aggiuntivo (come stabilito dall'indicazione per l'accesso), il componente aggiuntivo DEVE presentare un pulsante "Accedi con Google" per l'azione esplicita dell'utente per attivare la procedura di accesso.
Nota: questo è necessario per rispettare le linee guida per il branding di Google e aiuta anche a evitare i blocchi popup.
OBBLIGATORIO
  2,8 Il componente aggiuntivo DEVE mostrare chi è l'utente che ha eseguito l'accesso. CONSIGLIATA
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 intuitivo per tornare a Classroom. CONSIGLIATA
  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 Condividi di Classroom. OBBLIGATORIO
  3.4 Scelta della localizzazione: la lingua DEVE essere basata sulla preferenza locale impostata dal browser, se disponibile. CONSIGLIATA
  3,5 Se un componente aggiuntivo definisce maxPoints, DEVE impostare anche 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 DEVONO essere conformi alle linee guida sull'accessibilità WCAG 2.1 di livello AA. 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. CONSIGLIATA
  3.10 Eventuali errori riscontrati da un utente DEVONO essere leggibili da una persona. CONSIGLIATA
  3.11 Se studentViewUri, teacherViewUri o studentWorkViewUri viene avviato da un compito o un corso copiato, il componente aggiuntivo NON DEVE mostrare una pagina di errore nell'iframe. OBBLIGATORIO
4,0 Rilevamento degli allegati
  4.1 Se un allegato richiede l'invio da parte dello studente, l'allegato DEVE includere un studentWorkReviewUri in modo che venga considerato un tipo di attività e non un allegato di tipo di contenuto. OBBLIGATORIO
  4.2 L'iframe di Discovery degli allegati DEVE fornire un'interfaccia utente che offra almeno una delle seguenti opzioni:
  • Creare nuovi contenuti da allegare
  • Sfogliare, selezionare e allegare elementi 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. CONSIGLIATA
  4.4 L'insegnante DOVREBBE essere in grado di visualizzare l'anteprima dei contenuti/dell'attività prima di impegnarsi ad allegarli al compito. CONSIGLIATA
  4,5 Se l'insegnante deve creare contenuti/attività prima che possano essere allegati, questo lavoro DEVE essere completato nell'iframe. CONSIGLIATA
5.0 Visualizzazione Studente
  5.1 Quando viene lanciato studentViewUri, il componente aggiuntivo NON DEVE far uscire l'utente dall'iframe per completare un'attività.
Se il componente aggiuntivo fa uscire l'utente dall'iframe, DEVE essere presente un messaggio o un'altra indicazione per consentire agli studenti di tornare a Classroom.
CONSIGLIATA
  5.2 Se un'attività del componente aggiuntivo viene visualizzata nell'iframe, nell'iframe DOVREBBE essere presente un'anteprima dell'attività. CONSIGLIATA
  5.3 Se presente, un pulsante o un link nell'attività etichettato come Consegna DEVE attivare una richiesta API per inviare il lavoro dello studente per la revisione dell'insegnante. OBBLIGATORIO
6.0 Visualizzazione Insegnante
  6,1 L'insegnante DOVREBBE essere in grado di vedere ciò che vedrà lo studente quando svolge il compito. CONSIGLIATA
7.0 Revisione dei lavori degli studenti
  7,1 Se viene lanciato studentWorkReviewUri, il componente aggiuntivo DEVE visualizzare il lavoro dello studente per la revisione dell'insegnante all'interno dell'iframe. I materiali supplementari possono essere collegati all'esterno dell'iframe. OBBLIGATORIO
  7.2 Il componente aggiuntivo NON DEVE consentire la navigazione tra gli studenti nella visualizzazione studentWorkReviewUri. Il passaggio da uno studente all'altro DEVE avvenire solo nell'interfaccia utente di Classroom. OBBLIGATORIO
8.0 Assistenza per Classroom su dispositivi mobili
  8.1 Quando l'app mobile di Classroom avvia un teacherViewUri, un studentViewUri o un studentWorkReviewUri, l'URL DEVE aprire l'app mobile nativa o l'app web mobile del partner e, in entrambi i casi, deve includere un link diretto alla visualizzazione corretta. Se il dispositivo non è supportato, all'utente DEVE essere mostrato 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 completabile su un dispositivo mobile. CONSIGLIATA
9.0 Altre funzionalità
  9.1 Se gli insegnanti possono incollare link ai tuoi contenuti come allegati di link, DEVI eseguire l'upgrade dei link agli allegati dei componenti aggiuntivi. CONSIGLIATA
  9.2 Se utilizzi un'integrazione di CourseWork per creare i compiti dall'esterno di Classroom, devi creare gli allegati dei componenti aggiuntivi per impostazione predefinita per tutti i link compatibili con il tuo componente aggiuntivo. CONSIGLIATA

Log delle modifiche

Versione 1.1 Aggiornamento del 5 dicembre 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Modifica da OBBLIGATORI a CONSIGLIATO.
3,12 Rimosso.
5.3 Riformulata. Una modifica recente consente agli sviluppatori di componenti aggiuntivi di consegnare in modo affidabile i compiti degli studenti utilizzando l'API.
Versione 1.0 Aggiornamento del 30 aprile 2024
1.1 1.1 e 1.2 sono stati combinati in un unico requisito.
2.1 I punti 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 Sono stati combinati 3.5, 3.6 e 3.7 in un unico requisito.
3.10 È stato aggiunto il requisito che il componente aggiuntivo non entri mai in uno stato incomprensibile o non recuperabile.
3.11, 3.12 Sono stati combinati 5.5, 5.6, 6.3, 6.4, 7.5 e 7.6 in due nuovi requisiti.
4.2 È stata ampliata la descrizione delle esperienze di Ricerca di allegati accettabili.
4.3 Numero riassegnato, precedentemente 4.2. Inoltre, il valore è passato da OBBLIGATORIO a CONSIGLIATO.
4.4 Articolo rinumerato, precedentemente 4.3.
4,5 Numero modificato, precedentemente 4.4.
5.2 Numero modificato, precedentemente 5.3.
5.3 Numero riassegnato, precedentemente 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 per impostazione predefinita gli allegati dei componenti aggiuntivi quando si creano i compiti di Coursework tramite programmazione.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Rimosso.
Versione 0.3 Aggiornamento del 22 novembre 2022
2.3 Correzione alle indicazioni relative al suggerimento per l'accesso.
2,4 È stato incorporato uno scenario in cui è obbligatoria l'implementazione di hd.
3.2 Modifica della formulazione di "fornisci il percorso".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Sono state aggiunte indicazioni obbligatorie e consigliate per la copia dei corsi per studentViewUri, teacherViewUri e studentWorkReviewUri.
Versione 0.2 Aggiornamento del 29 ottobre 2021
1.3 Il testo è stato modificato per chiarire le intenzioni.
3.1 È stato aggiunto il seguente testo: "Il componente aggiuntivo DEVE rispettare le linee guida generali per l'approvazione di GWM disponibili sul relativo sito web".
3,9 Le WCAG hanno modificato il requisito OBBLIGATORIO in CONSIGLIATO.
5.1 Il valore OBBLIGATORIA è stato modificato in CONSIGLIATA.
5.3 È stato aggiunto il seguente testo: "Se i componenti aggiuntivi vengono visualizzati in un popup nell'iframe, nell'iframe deve essere presente un'anteprima dell'attività".
5.4 È stato aggiunto il seguente testo: "Se il componente aggiuntivo viene visualizzato nell'iframe, DOVREBBE essere visualizzato un messaggio che invita gli studenti a tornare a Classroom".
8.1 È stato aggiunto il messaggio "Se il dispositivo non è supportato, all'utente deve essere mostrato un messaggio che lo informa che si tratta di un dispositivo non supportato e, idealmente, quali sono i dispositivi supportati".
8.2 Il lavoro degli studenti da dispositivo mobile è passato da OBBLIGATORIO a CONSIGLIATO.
Versione 0.1 Aggiornamento del 22 settembre 2021
  Lancio iniziale.