Mengupgrade lampiran Link ke lampiran add-on Classroom

Salah satu cara pengajar menambahkan konten pihak ketiga ke Classroom adalah dengan menempel link sebagai Lampiran link di halaman pembuatan tugas. Untuk membuat hal yang sudah dikenal pengajar, kini Anda dapat mengonfigurasi add-on untuk memungkinkan pengajar mengupgrade lampiran Link menjadi lampiran add-on.

Ringkasan

Jika Anda mengonfigurasi add-on dengan kemampuan ini, pengajar akan diminta untuk mengupgrade link ke lampiran add-on saat mereka menempelkan lampiran Link di halaman pembuatan tugas. Pengajar hanya diminta untuk melakukannya jika mereka sudah menginstal add-on.

Setelah pengajar setuju untuk mengupgrade link ke lampiran add-on, iframe Upgrade Link akan diluncurkan dengan parameter kueri berikut:

• courseId
• itemId
• itemType
• addOnToken
• urlToUpgrade
• login_hint (hanya jika pengguna telah memberikan otorisasi ke aplikasi Anda)

Empat parameter kueri pertama mencerminkan parameter kueri yang diluncurkan di iframe Penemuan Lampiran. Parameter kueri urlToUpgrade adalah parameter baru dan dapat membantu Anda mengevaluasi cara membuat lampiran add-on. Kemudian, Anda dapat menggunakan parameter kueri lainnya untuk memeriksa apakah pengguna login dan memanggil metode CreateAddOnAttachment dari courseWork, courseWorkMaterials, atau announcements berdasarkan nilai itemType. Dalam iframe, Anda dapat menampilkan layar pemuatan untuk menunjukkan kepada pengajar bahwa lampiran add-on sedang dibuat.

Setelah lampiran add-on dibuat, iframe akan ditutup dan pengajar dapat melihat lampiran dalam tugas seperti biasa.

Detail penerapan teknis

Bagian ini menyoroti beberapa detail teknis penting untuk fitur ini.

Membaca parameter kueri urlToUpgrade

Parameter kueri urlToUpgrade dienkode dengan URI saat diteruskan pada iframe Link Upgrade. Anda harus mendekode URL untuk mendapatkannya dalam bentuk aslinya. Misalnya, jika menggunakan JavaScript, Anda dapat menggunakan fungsi decodeURIComponent() untuk melakukannya.

Menutup iframe Upgrade Link

Untuk memastikan pengalaman pengguna yang optimal untuk fitur ini, kirim postMessage setelah lampiran add-on berhasil dibuat. Tindakan ini akan menutup iframe. Lihat halaman detail penerapan iframe untuk mengetahui detail selengkapnya.

Detail konfigurasi

Konfigurasi berikut diperlukan untuk mengintegrasikan fitur ini ke dalam add-on Anda:

• URL untuk iframe Upgrade Link: Ini adalah URL yang akan terbuka di iframe saat pengajar setuju untuk melakukan upgrade.

• Pola URL yang harus dideteksi dan dicoba diupgrade oleh Classroom: Pola URL dapat terdiri dari host dan beberapa awalan jalur.

  • Anda dapat memberikan beberapa pola URL.
  • Jika Anda tidak memberikan awalan jalur, URL apa pun yang cocok dengan host dapat diupgrade.
  • Hanya URL dengan skema https yang dapat diupgrade.
  • Pola URL tidak boleh berisi localhost.
  • Awalan jalur tidak boleh berisi parameter kueri atau fragmen URL.
  • Awalan jalur dapat mendukung karakter pengganti saat ini, tetapi host tidak dapat:
    • example.com adalah host yang valid, dan /foo dan /bar/*/baz adalah awalan jalur yang valid.
    • example.*.host.com bukan host yang valid.
  • Karakter pengganti di antara komponen awalan jalur hanya cocok dengan satu komponen, dan tidak cocok dengan beberapa komponen yang dipisahkan oleh garis miring. Pertimbangkan pola URL dengan host example.com dan awalan jalur /bar/*/baz:
    • https://example.com/bar/123/baz adalah kecocokan yang valid untuk pola URL.
    • https://example.com/bar/123/baz/456/789 adalah kecocokan yang valid untuk pola URL.
    • https://example.com/bar/123/456/baz bukan kecocokan yang valid untuk pola URL karena karakter pengganti di awalan jalur tidak cocok dengan /123/456/.

Catatan: Karakter pengganti di antara komponen awalan jalur hanya cocok dengan satu komponen.

Proses pengembangan

Kirim URL iframe Link Upgrade dan pola URL untuk add-on pengujian atau produksi Anda dengan mengirim email ke [e-mail].

Anda dapat memberikan konfigurasi untuk project Google Cloud apa pun yang mewakili add-on Classroom. Sebaiknya berikan konfigurasi untuk add-on dengan visibilitas pribadi terlebih dahulu agar Anda dapat mengembangkan dan menguji di domain demo tanpa memengaruhi pengguna aktif.

Anda akan menerima respons melalui email saat konfigurasi telah diaktifkan. Perhatikan bahwa pola URL yang menggunakan localhost tidak didukung untuk fitur ini.

Penting: Pengguna yang dapat menginstal dan menggunakan add-on Anda dapat mengupgrade link ke lampiran add-on segera setelah konfigurasi diaktifkan oleh tim Classroom. Itulah sebabnya penting untuk terlebih dahulu menyediakan konfigurasi untuk add-on pengujian dalam lingkungan pengujian atau pengembangan sebelum menyediakan konfigurasi produksi apa pun.

Format email untuk menyertakan hal berikut:

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

Ganti kode berikut:

• GCP_PROJECT_NUMBER: Nomor project Google Cloud yang terkait dengan add-on.
• LINK_UPGRADE_IFRAME_URL: URL yang akan terbuka di iframe Upgrade Link.
• HOST_1: Host yang harus dideteksi Classroom. Hanya skema https yang didukung.
• PATH_PREFIX_1 dan PATH_PREFIX_2: Awalan jalur yang terkait dengan HOST_1 yang harus dideteksi dan dicoba diupgrade oleh Classroom.
• HOST_2: Host yang harus dideteksi Classroom. Hanya skema https yang didukung.
• PATH_PREFIX_3 dan PATH_PREFIX_4: Awalan jalur yang terkait dengan HOST_2 yang harus dideteksi dan dicoba diupgrade oleh Classroom.

Pengalaman pengguna yang direkomendasikan

Berikut adalah saran yang perlu dipertimbangkan saat menerapkan fitur ini.

Menghindari pekerjaan tambahan bagi pengajar

Sebaiknya gunakan iframe untuk memfasilitasi login, jika diperlukan, atau menampilkan indikator pemuatan. Untuk pengalaman pengguna terbaik, pengajar tidak boleh diminta untuk memberikan informasi tambahan apa pun setelah menyetujui untuk mengupgrade link yang ditempelkan ke lampiran add-on. Namun, jika hal ini tidak memungkinkan untuk add-on Anda, Anda dapat menggunakan iframe Link Upgrade untuk mengumpulkan informasi tambahan yang Anda perlukan. Iframe juga dapat digunakan untuk memberi tahu guru jika upgrade link tidak dapat dilakukan atau jika terjadi error.

Menyertakan pesan error akses yang mudah digunakan

Jika pengajar menempelkan dan mengupgrade link yang tidak dapat diakses, tampilkan pesan error yang mudah digunakan di iframe agar pengajar mengetahui masalahnya. Iframe juga dapat digunakan untuk memberi pengajar izin yang sesuai untuk mengakses konten.