Eseguire l'upgrade degli allegati Link agli allegati del componente aggiuntivo di Classroom

Un modo in cui gli insegnanti aggiungono contenuti di terze parti a Classroom è incollando un link come Allegato link nella pagina di creazione del compito. Per creare agli insegnanti con cui hanno già familiarità, ora puoi configurare il tuo componente aggiuntivo consentire agli insegnanti di eseguire l'upgrade di un allegato di un link a un allegato di un componente aggiuntivo.

Panoramica

Se configuri il componente aggiuntivo con questa funzionalità, agli insegnanti viene richiesto di eseguire l'upgrade di un link all'allegato di un componente aggiuntivo quando incolla un allegato del link nella pagina di creazione dei compiti. Agli insegnanti viene chiesto di farlo solo se già installare il componente aggiuntivo.

Una volta che l'insegnante accetta di eseguire l'upgrade del link a un allegato di un componente aggiuntivo, il link L'upgrade dell'iframe viene avviato con i seguenti parametri di query:

• courseId
• itemId
• itemType
• addOnToken
• urlToUpgrade
• login_hint (solo se l'utente ha già autorizzato la tua app)

I primi quattro parametri di query rispecchiano quelli della query iframe discovery allegato. Il parametro di query urlToUpgrade è nuovo e può ti aiutano a valutare come creare l'allegato del componente aggiuntivo. Quindi puoi utilizzare gli altri parametri di query per verificare se l'utente ha eseguito l'accesso e richiamare Metodo CreateAddOnAttachment di courseWork, courseWorkMaterials o announcements in base al valore itemType. All'interno dell'iframe, puoi mostra una schermata di caricamento per indicare all'insegnante che l'allegato del componente aggiuntivo è in fase di creazione.

Una volta creato l'allegato del componente aggiuntivo, l'iframe viene chiuso e l'insegnante può visualizzare l'allegato nel compito come farebbe normalmente.

Dettagli tecnici sull'implementazione

Questa sezione evidenzia alcuni importanti dettagli tecnici della funzionalità.

Leggi il parametro di query urlToUpgrade

Il parametro di query urlToUpgrade è codificato in URI quando viene passato tramite il link Esegui l'upgrade dell'iframe. Devi decodificare l'URL per ottenerlo nella sua forma originale. Se usi JavaScript, ad esempio puoi usare l'decodeURIComponent() per eseguire questa operazione.

Chiudi l'iframe dell'upgrade dei link

Per garantire un'esperienza utente ottimale per questa funzionalità, invia una volta postMessage l'allegato del componente aggiuntivo è stato creato. L'iframe viene chiuso. Consulta per ulteriori informazioni, consulta la pagina dei dettagli dell'implementazione dell'iframe.

Dettagli configurazione

Per integrare questa funzionalità nel tuo account sono necessarie le seguenti configurazioni Componente aggiuntivo:

• URL per l'iframe dell'upgrade del link: si tratta dell'URL che si apre nella iframe quando un insegnante accetta di eseguire l'upgrade.

• Pattern URL che Classroom deve rilevare e tentare di upgrade: i pattern URL possono essere costituiti da un host e da più percorsi prefissi.

  • Puoi fornire più pattern URL.
  • Se non fornisci prefissi del percorso, puoi usare qualsiasi URL che corrisponda all'host eseguire l'upgrade.
  • È possibile eseguire l'upgrade solo degli URL con uno schema https.
  • I pattern URL non devono contenere localhost.
  • I prefissi del percorso non devono contenere parametri di query o frammenti di URL.
  • Al momento i prefissi percorso possono supportare i caratteri jolly, ma gli host non possono:
    • example.com è un host valido, e /foo e /bar/*/baz sono prefissi di percorso validi.
    • example.*.host.com non è un host valido.
  • Un carattere jolly tra i componenti del prefisso del percorso corrisponde a un solo e non corrisponde a più componenti separati da barre. Considera un pattern URL con l'host example.com e il prefisso del percorso /bar/*/baz:
    .
    • https://example.com/bar/123/baz è una corrispondenza valida per l'URL pattern.
    • https://example.com/bar/123/baz/456/789 è una corrispondenza valida per Pattern URL.
    • https://example.com/bar/123/456/baz non è una corrispondenza valida per Pattern URL perché il carattere jolly nel prefisso del percorso non corrisponde /123/456/.

Nota: i caratteri jolly tra i componenti del prefisso del percorso corrispondono a un solo componente.

Processo di sviluppo

Invia l'URL dell'iframe dell'upgrade del link e i pattern URL per il test o la produzione per il componente aggiuntivo inviando un'email a [e-mail].

Puoi fornire configurazioni per qualsiasi progetto Google Cloud che rappresenti un Componente aggiuntivo di Classroom. Ti consigliamo di fornire prima per un componente aggiuntivo con visibilità privata, in modo da poter sviluppare e testarlo in un dominio demo senza influire sugli utenti attivi.

Riceverai una risposta alla tua email dopo che le configurazioni saranno state in un bucket in cui è abilitato il controllo delle versioni. Tieni presente che i pattern URL che utilizzano localhost non sono supportati funzionalità.

Importante: gli utenti che possono installare e utilizzare il componente aggiuntivo possono eseguire l'upgrade dei link a allegati di componenti aggiuntivi non appena le configurazioni vengono attivate dal team di Classroom. Per questo è importante fornire innanzitutto configurazioni per il componente aggiuntivo di test in un ambiente di test o sviluppo fornendo eventuali configurazioni di produzione.

Formatta l'email in modo da includere quanto segue:

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

Sostituisci quanto segue:

• GCP_PROJECT_NUMBER: il numero del progetto Google Cloud a cui è associato il componente aggiuntivo.
• LINK_UPGRADE_IFRAME_URL: l'URL che dovrebbe aprirsi nella Esegui l'upgrade del link iframe.
• HOST_1: un host che Classroom deve rilevare. Solo il Lo schema https è supportato.
• PATH_PREFIX_1 e PATH_PREFIX_2: percorso prefissi associati a HOST_1 che Classroom deve rilevare e tentare per eseguire l'upgrade.
• HOST_2: un host che Classroom deve rilevare. Solo il Lo schema https è supportato.
• PATH_PREFIX_3 e PATH_PREFIX_4: percorso prefissi associati a HOST_2 che Classroom deve rilevare e tentare per eseguire l'upgrade.

Esperienza utente consigliata

Di seguito sono riportati alcuni suggerimenti da prendere in considerazione durante l'implementazione di questa funzionalità.

Evitare il lavoro extra per gli insegnanti

Ti consigliamo vivamente di utilizzare l'iframe per facilitare l'accesso, se o mostrare un indicatore di caricamento. Per una migliore esperienza utente, all'insegnante non dovrebbero essere chieste ulteriori informazioni dopo aver ha accettato di eseguire l'upgrade del link incollato a un allegato del componente aggiuntivo. Tuttavia, se si tratta di non è possibile per il tuo componente aggiuntivo, puoi utilizzare l'iframe dell'upgrade del link per raccogliere le informazioni aggiuntive di cui hai bisogno. L'iframe può essere utilizzato anche per informare insegnante se non è possibile eseguire l'upgrade del link o se si è verificato un errore.

Includi messaggi di errore relativi all'accesso facile da usare

Se gli insegnanti incollano ed eseguono l'upgrade di un link a cui non hanno accesso, mostra un un messaggio di errore semplice da usare per informare gli insegnanti del problema. L'iframe può essere utilizzato anche per fornire all'insegnante gli autorizzazioni per accedere ai contenuti.