Requisiti per i componenti aggiuntivi

Versione 1.1, 5 dicembre 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 come componente aggiuntivo che "Funziona con Classroom".

Le parole chiave "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY" e "OPTIONAL" in questo documento devono essere interpretate come descritto in 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 dispone di una licenza. Il messaggio DEVE indicare chiaramente il motivo per cui il componente aggiuntivo non può essere utilizzato e suggerire all'utente un corso d'azione per risolvere la situazione. CONSIGLIATA
  1.3 La scheda di Google Workspace Marketplace per il componente aggiuntivo DEVE 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 del Marketplace DEVE fornire un link a una pagina web che offre maggiori informazioni sui prezzi o su come contattare un addetto alle vendite. CONSIGLIATA
2.0 Accesso utente finale
  2.1 Gli utenti Insegnante DEVONO accedere al componente aggiuntivo utilizzando l'SSO di Google.
Se agli studenti viene chiesto di accedere al componente aggiuntivo, DEVONO accedere utilizzando l'SSO di Google.		 OBBLIGATORIO
  2.2 Il componente aggiuntivo DEVE utilizzare Google SSO per accedere automaticamente a un utente nelle visite successive senza mostrare una richiesta di accesso.
Quando il suggerimento di accesso non produce una corrispondenza con l'utente attualmente connesso, il componente aggiuntivo DEVE chiedere all'utente di accedere con un pulsante di accesso e passare il suggerimento di accesso 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 determinato dall'hint di accesso), il componente aggiuntivo DEVE presentare un pulsante "Accedi con Google" per l'azione esplicita dell'utente per attivare la procedura di accesso.
Nota: questa operazione è necessaria per rispettare le linee guida per il branding di Google e contribuisce anche a evitare i blocchi dei popup.		 OBBLIGATORIO
  2,8 Il componente aggiuntivo DEVE mostrare l'utente attualmente connesso. 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 qualsiasi dei percorsi iframe, DEVE fornire un messaggio intuitivo per tornare a Classroom. CONSIGLIATA
  3.3 L'utente DEVE completare il percorso solo utilizzando 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 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) O quando l'insegnante apre l'invio nell'iframe Revisione del lavoro dello studente. 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 continua 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 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 un compito da parte dello studente, DEVE includere un studentWorkReviewUri in modo che venga trattato come un tipo di attività e non come un allegato di tipo di contenuto. 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 un elemento 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/attività disponibili. 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 di poterli allegare, il lavoro DEVE essere completato nell'iframe. CONSIGLIATA
5.0 Visualizzazione studente
  5.1 Quando viene avviato studentViewUri, il componente aggiuntivo NON DEVE 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 consentire agli studenti di tornare a Classroom.		 CONSIGLIATA
  5.2 Se un'attività del componente aggiuntivo viene visualizzata all'esterno dell'iframe, DOVREBBE essere presente un'anteprima dell'attività nell'iframe. CONSIGLIATA
  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 insegnante
  6,1 L'insegnante DOVREBBE essere in grado di vedere ciò che vedrà lo studente quando svolgerà il compito. CONSIGLIATA
7.0 Revisione dei lavori degli studenti
  7,1 Se viene avviato studentWorkReviewUri, il componente aggiuntivo DEVE visualizzare il lavoro dello studente per la revisione dell'insegnante all'interno dell'iframe. Il materiale supplementare può essere collegato all'esterno dell'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 mobile di Classroom
  8.1 Quando l'app mobile Classroom avvia un teacherViewUri, un studentViewUri o un studentWorkReviewUri, l'URL DEVE aprire l'app mobile nativa del partner o l'app web mobile del partner e, in entrambi i casi, deve essere collegato in modo diretto alla visualizzazione corretta. Se il dispositivo non è supportato, all'utente DEVE essere visualizzato un messaggio che lo informi che si tratta di un dispositivo non supportato e, idealmente, quali dispositivi sono supportati. OBBLIGATORIO
  8.2 Il lavoro degli studenti DEVE poter essere completato 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 a componenti aggiuntivi da allegare. CONSIGLIATA
  9.2 Se utilizzi un'integrazione di CourseWork per creare compiti al di fuori di Classroom, DEVI creare allegati dei componenti aggiuntivi per impostazione predefinita per tutti i link compatibili con il componente aggiuntivo. CONSIGLIATA

Log delle modifiche

Versione 1.1 Ultimo aggiornamento: 5 dicembre 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Modifica: da OBBLIGATORIO a CONSIGLIATO.
3,12 Rimosso.
5.3 Riformulato. Una recente modifica consente agli sviluppatori di componenti aggiuntivi di consegnare in modo affidabile i compiti degli studenti utilizzando l'API.
Versione 1.0 Ultimo aggiornamento: 30 aprile 2024
1.1 Le sezioni 1.1 e 1.2 sono state combinate in un unico requisito.
2.1 I requisiti 2.1 e 2.5 sono stati combinati in un unico requisito.
2.2 I punti 2.2, 2.3 e 2.4 sono stati combinati in un unico requisito.
3,5 Le versioni 3.5, 3.6 e 3.7 sono state combinate 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 Sono stati combinati i requisiti 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 scoperta degli allegati accettabili.
4.3 Rinumero, precedentemente 4.2. Inoltre, è stato modificato da OBBLIGATORIO a CONSIGLIATO.
4.4 Rinumero, in precedenza 4.3.
4,5 Rinumero, precedentemente 4.4.
5.2 Rinumero, precedentemente 5.3.
5.3 Rinumero, precedentemente 5.2.
9.1 È stato aggiunto un suggerimento per eseguire l'upgrade dei link incollati agli allegati.
9.2 È stato aggiunto un suggerimento per creare allegati di componenti aggiuntivi per impostazione predefinita quando si creano compiti di CourseWork in modo programmatico.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Rimosso.
Versione 0.3 Aggiornamento: 22 novembre 2022
2.3 Correzione delle indicazioni per il suggerimento di accesso.
2,4 È stato incorporato uno scenario in cui è necessario implementare hd.
3.2 Riformulato "fornisci percorso".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Aggiunta di indicazioni obbligatorie e consigliate per la copia dei corsi per studentViewUri, teacherViewUri e studentWorkReviewUri.
Versione 0.2 Ultimo aggiornamento: 29 ottobre 2021
1.3 Il testo è stato modificato per rendere più chiaro 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 Le WCAG hanno modificato REQUIRED in RECOMMENDED.
5.1 REQUIRED è stato modificato in RECOMMENDED.
5.3 È stato aggiunto "Se i componenti aggiuntivi vengono visualizzati all'esterno dell'iframe, DEVE essere presente un'anteprima dell'attività nell'iframe".
5.4 È stato aggiunto il testo "Se il componente aggiuntivo esce dall'iframe, DOVREBBE essere presente un prompt per consentire agli 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 informi che si tratta di un dispositivo non supportato e, idealmente, quali dispositivi sono supportati".
8.2 Il lavoro degli studenti su dispositivi mobili è passato da OBBLIGATORIO a CONSIGLIATO.
Versione 0.1 Aggiornamento: 22 settembre 2021
  Release iniziale.