I componenti aggiuntivi di Google Classroom sono ora in disponibilità generale per gli sviluppatori. Per ulteriori informazioni, consulta la documentazione relativa ai componenti aggiuntivi.

Questa pagina è stata tradotta dall'API Cloud Translation.

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 di link nella pagina di creazione del compito. Per fare leva su ciò che gli insegnanti già conoscono, ora puoi configurare il tuo componente aggiuntivo per consentire agli insegnanti di eseguire l'upgrade di un allegato di link a un allegato del componente aggiuntivo.

Panoramica

Se configuri il componente aggiuntivo con questa funzionalità, agli insegnanti viene chiesto di eseguire l'upgrade di un link a un allegato del componente aggiuntivo quando incollano un allegato di tipo Link nella pagina di creazione del compito. Agli insegnanti viene chiesto di farlo solo se hanno già installato il componente aggiuntivo.

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

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

I primi quattro parametri di query rispecchiano i parametri di query lanciati nell'iframe di Attachment Discovery. Il parametro di query urlToUpgrade è nuovo e può aiutarti a valutare come deve essere creato l'allegato del componente aggiuntivo. Poi, puoi utilizzare gli altri parametri della query per verificare se l'utente ha eseguito l'accesso e chiamare il metodo CreateAddOnAttachment di courseWork, courseWorkMaterials o announcements in base al valore di itemType. All'interno dell'iframe, puoi visualizzare 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 di consueto.

Dettagli tecnici di implementazione

Questa sezione evidenzia alcuni dettagli tecnici importanti della funzionalità.

Leggi il parametro di query `urlToUpgrade`

Il parametro di query urlToUpgrade viene codificato URI quando viene trasmesso nell'iframe di upgrade del link. Devi decodificare l'URL per ottenerlo nella sua forma originale. Se utilizzi JavaScript, ad esempio, puoi utilizzare la funzione decodeURIComponent() per farlo.

Chiudi l'iframe di upgrade del link

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

Dettagli configurazione

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

URL dell'iframe per l'upgrade del link: questo è l'URL che si apre nell'iframe quando un insegnante accetta l'upgrade.
Pattern URL che Classroom deve rilevare e tentare di aggiornare: i pattern URL possono essere costituiti da un host e da più prefissi del percorso.
- Puoi fornire più pattern URL.
- Se non fornisci prefissi di percorso, è possibile eseguire l'upgrade di qualsiasi URL che corrisponde all'host.
- È possibile eseguire l'upgrade solo degli URL con 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 del percorso possono supportare i caratteri jolly, ma gli host no:
  - example.com è un host valido, mentre /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 componente e non 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 il pattern dell'URL.
  - https://example.com/bar/123/baz/456/789 è una corrispondenza valida per il pattern URL.
  - https://example.com/bar/123/456/baz non è una corrispondenza valida per il pattern URL perché il carattere jolly nel prefisso del percorso non corrisponde a /123/456/.

Processo di sviluppo

Invia l'URL dell'iframe di aggiornamento dei link e i pattern URL per il tuo componente aggiuntivo di test o di produzione inviando un'email all'indirizzo classroom-link-upgrade-external@google.com.

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

Riceverai una risposta alla tua email quando le configurazioni saranno state attivate. Tieni presente che i pattern URL che utilizzano localhost non sono supportati per questa funzionalità.

Formatta l'email in modo che includa 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 deve aprirsi nell'iframe dell'upgrade dei link.
HOST_1: un host che Classroom deve rilevare. È supportato solo lo schema https.
PATH_PREFIX_1 e PATH_PREFIX_2: prefissi del percorso associati a HOST_1 che Classroom deve rilevare e tentare di aggiornare.
HOST_2: un host che Classroom deve rilevare. È supportato solo lo schema https.
PATH_PREFIX_3 e PATH_PREFIX_4: prefissi del percorso associati a HOST_2 che Classroom deve rilevare e tentare di aggiornare.

Esperienza utente consigliata

Di seguito sono riportati alcuni suggerimenti da prendere in considerazione quando implementi questa funzionalità.

Evitare lavoro extra per gli insegnanti

Ti consigliamo vivamente di utilizzare l'iframe per facilitare l'accesso, se necessario, o visualizzare un indicatore di caricamento. Per garantire la migliore esperienza utente, all'insegnante non devono essere richieste informazioni aggiuntive dopo che ha accettato di eseguire l'upgrade del link incollato a un allegato del componente aggiuntivo. Tuttavia, se ciò non è possibile per il tuo componente aggiuntivo, puoi utilizzare l'iframe Link Upgrade per raccogliere le informazioni aggiuntive di cui hai bisogno. L'iframe può essere utilizzato anche per informare l'insegnante se l'upgrade del link non è possibile o se si è verificato un errore.

Includere messaggi di errore di accesso di facile comprensione per gli utenti

Se gli insegnanti incollano e aggiornano un link a cui non hanno accesso, visualizza un messaggio di errore intuitivo nell'iframe in modo che gli insegnanti siano a conoscenza del problema. L'iframe può essere utilizzato anche per fornire all'insegnante le autorizzazioni appropriate per accedere ai contenuti.