Eine Möglichkeit, wie Lehrkräfte Classroom-Inhalte von Drittanbietern hinzufügen, ist Einfügen eines Links als Linkanhang auf der Seite zur Aufgabenerstellung Zum Erstellen vertraut sind, können Sie das Add-on jetzt so konfigurieren, Lehrkräfte können einen Linkanhang in einen Add-on-Anhang umwandeln.
Übersicht
Wenn Sie Ihr Add-on mit dieser Funktion konfigurieren, werden Lehrkräfte aufgefordert, einen Link zu einem Add-on-Anhang aktualisieren, wenn sie einen Linkanhang im Seite zur Aufgabenerstellung. Lehrkräfte werden nur dazu aufgefordert, wenn sie bereits auf denen das Add-on installiert ist.
Sobald die Lehrkraft dem Upgrade des Links zu einem Add-on-Anhang zugestimmt hat, wird der Link Das Upgrade von iFrame wird mit den folgenden Abfrageparametern gestartet:
courseId
itemId
itemType
addOnToken
urlToUpgrade
login_hint
(nur, wenn der Nutzer deine App bereits autorisiert hat)
Die ersten vier Suchparameter spiegeln die Suchparameter wider, die im
iFrame zur Anhangserkennung Der Abfrageparameter urlToUpgrade
ist neu und kann
helfen Ihnen bei der Beurteilung, wie der Add-on-Anhang erstellt werden sollte. Dann können Sie
die anderen Suchparameter, um zu prüfen, ob der Nutzer angemeldet ist, und ruft die Funktion
Methode CreateAddOnAttachment
von courseWork
, courseWorkMaterials
oder
announcements
basierend auf dem Wert itemType
. Im iFrame haben Sie folgende Möglichkeiten:
einen Ladebildschirm anzeigen, um die Lehrkraft darüber zu informieren, dass das Add-on-Anhang
erstellt wird.
Sobald der Add-on-Anhang erstellt wurde, wird der iFrame geschlossen und der die Lehrkraft den Anhang in der Aufgabe wie gewohnt ansehen kann.
Details zur technischen Implementierung
In diesem Abschnitt werden einige wichtige technische Details zu dieser Funktion erläutert.
Abfrageparameter urlToUpgrade
lesen
Der Abfrageparameter urlToUpgrade
wird URI-codiert, wenn er an den Link übergeben wird
iFrame aktualisieren. Sie müssen die URL decodieren, um sie in ihrer ursprünglichen Form abzurufen. Wenn
Wenn du JavaScript verwendest, kannst du beispielsweise die decodeURIComponent()
verwenden.
iFrame für Linkupgrade schließen
Sende einmal eine postMessage
-Anfrage, um diese Funktion optimal nutzen zu können
Der Add-on-Anhang wurde erstellt. Dadurch wird der iFrame geschlossen. Weitere Informationen finden Sie unter
Weitere Informationen finden Sie auf der Detailseite zur iFrame-Implementierung.
Konfigurationsdetails
Die folgenden Konfigurationen sind erforderlich, um diese Funktion in Ihr Add-on:
URL für den iFrame für die Linkumstellung: Das ist die URL, die im iFrame, wenn eine Lehrkraft dem Upgrade zustimmt.
URL-Muster, die Classroom erkennen und versuchen soll Upgrade: Die URL-Muster können aus einem Host und mehreren Pfaden bestehen. Präfixe.
- Sie können mehrere URL-Muster angeben.
- Wenn Sie keine Pfadpräfixe angeben, werden alle URLs, die mit dem Host aktualisiert werden kann.
- Nur URLs mit dem Schema
https
können umgestellt werden. - URL-Muster dürfen nicht
localhost
enthalten. - Pfadpräfixe dürfen keine Suchparameter oder URL-Fragmente enthalten.
- Für Pfadpräfixe können derzeit Platzhalter verwendet werden, für Hosts jedoch nicht:
-
example.com
ist ein gültiger Host. und/foo
und/bar/*/baz
sind gültige Pfadpräfixe. -
example.*.host.com
ist kein gültigen Host.
-
- Ein Platzhalter zwischen Pfadpräfixkomponenten entspricht nur einem
Komponente und stimmt nicht mit mehreren durch Schrägstrich getrennten Komponenten überein.
Hier ein URL-Muster mit dem Host
example.com
und dem Pfadpräfix/bar/*/baz
:-
https://example.com/bar/123/baz
ist eine gültige Übereinstimmung für die URL Muster zu ändern. -
https://example.com/bar/123/baz/456/789
ist eine gültige Übereinstimmung für URL-Muster. -
https://example.com/bar/123/456/baz
ist keine gültige Übereinstimmung für URL-Muster, da der Platzhalter im Pfadpräfix nicht übereinstimmt/123/456/
.
-
Entwicklungsablauf
Senden Sie die iFrame-URL und URL-Muster für das Linkupgrade für Ihren Test oder die Produktion indem Sie eine E-Mail an classroom-link-upgrade-external@google.com senden.
Sie können Konfigurationen für jedes Google Cloud-Projekt angeben, das ein Classroom-Add-on. Wir empfehlen Ihnen, Konfigurationen für ein Add-on mit privater Sichtbarkeit, damit Sie und Tests in einer Demodomain durchführen, ohne dass sich dies auf Live-Nutzer auswirkt.
Sie erhalten eine Antwort auf Ihre E-Mail, sobald die Konfigurationen abgeschlossen sind
aktiviert. URL-Muster, die localhost
verwenden, werden hierfür nicht unterstützt
.
Die E-Mail sollte Folgendes enthalten:
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
Ersetzen Sie Folgendes:
- GCP_PROJECT_NUMBER: die Nummer des Google Cloud-Projekts mit dem das Add-on verknüpft ist.
- LINK_UPGRADE_IFRAME_URL: Die URL, die im Link Upgrade für iFrame ausführen.
- HOST_1: Ein Host, den Classroom erkennen soll. Nur die
Das Schema
https
wird unterstützt. - PATH_PREFIX_1 und PATH_PREFIX_2: Pfad
Mit
HOST_1
verknüpfte Präfixe, die in Classroom erkannt und versucht werden sollen um ein Upgrade auszuführen. - HOST_2: Ein Host, den Classroom erkennen soll. Nur die
Das Schema
https
wird unterstützt. - PATH_PREFIX_3 und PATH_PREFIX_4: Pfad
Mit
HOST_2
verknüpfte Präfixe, die in Classroom erkannt und versucht werden sollen um ein Upgrade auszuführen.
Empfohlene Nutzererfahrung
Im Folgenden finden Sie einige Vorschläge, die Sie bei der Implementierung dieser Funktion berücksichtigen sollten.
Mehraufwand für Lehrkräfte
Wir empfehlen dringend, den iFrame zu verwenden, um die Anmeldung zu erleichtern, wenn erforderlich oder eine Ladeanzeige anzeigen. Für eine optimale Nutzererfahrung sollte eine Lehrkraft nicht aufgefordert werden, zusätzliche Informationen hat zugestimmt, den eingefügten Link in einen Add-on-Anhang zu aktualisieren. Wenn dies jedoch nicht möglich ist, können Sie mit dem iFrame für das Link-Upgrade die Sie benötigen. Der iFrame kann auch verwendet werden, um den Lehrkraft, wenn der Link nicht aktualisiert werden kann oder ein Fehler aufgetreten ist.
Nutzerfreundliche Fehlermeldungen beim Zugriff anzeigen
Wenn Lehrkräfte einen Link einfügen und aktualisieren, auf den sie keinen Zugriff haben, wird ein Fehlermeldung im iFrame, damit die Lehrkräfte über das Problem informiert sind. Über den iFrame kann die Lehrkraft auch die entsprechenden um auf die Inhalte zuzugreifen.