detail iframe dan parameter kueri

Add-on Classroom dimuat dalam iframe untuk memberikan pengalaman pengguna yang lancar dan nyaman kepada pengguna akhir. Ada empat jenis iframe yang berbeda; lihat halaman iframe di direktori Perjalanan pengguna untuk mengetahui ringkasan tujuan dan tampilan setiap iframe.

panduan keamanan iframe

Partner diharapkan mengikuti praktik terbaik industri untuk mengamankan iframe mereka. Untuk melindungi iframe, tim keamanan kami menyarankan hal berikut:

• HTTPS diperlukan. Sebaiknya gunakan TLS 1.2 atau yang lebih baru dan aktifkan HTTP Strict Transport Security. Lihat artikel MDN terkait tentang Strict Transport Security.

• Aktifkan Kebijakan Keamanan Konten Ketat. Lihat artikel OWASP ini dan artikel MDN Kebijakan Keamanan Konten terkait ini.

• Aktifkan Atribut cookie aman. Lihat atribut HttpOnly dan artikel MDN Cookie terkait ini.

Konfigurasi URI iFrame

URI Penyiapan Lampiran adalah tempat yang dimuat oleh iframe Penemuan Lampiran, dan merupakan tempat pengajar memulai alur pembuatan lampiran add-on di postingan Classroom. Atribut ini dapat ditetapkan di konsol project Google Cloud. Tetapkan URI ini di halaman API & Layanan project Google Cloud > Google Workspace Marketplace SDK > App Configuration.

Awalan URI Lampiran yang Diizinkan digunakan untuk memvalidasi URI yang ditetapkan di AddOnAttachment menggunakan metode *.addOnAttachments.create dan *.addOnAttachments.patch. Validasi adalah pencocokan awalan string literal dan saat ini tidak mengizinkan penggunaan karakter pengganti.

Parameter kueri

iframe meneruskan informasi penting ke add-on sebagai parameter kueri. Ada dua kategori parameter: parameter terkait lampiran dan terkait login.

Parameter terkait lampiran

Parameter terkait lampiran memberikan add-on berisi informasi tentang kursus, tugas, lampiran add-on, kiriman siswa, dan token otorisasi.

ID Kursus

Nilai courseId adalah ID untuk kursus.

Disertakan dengan semua iframe.

ID Item

Nilai itemId adalah ID dari Announcement,

CourseWork, atau CourseWorkMaterial tempat lampiran ini dilampirkan.

Disertakan dengan semua iframe.

Jenis Item

Nilai itemType mengidentifikasi jenis resource tempat

lampiran dilampirkan. Nilai string yang diteruskan adalah salah satu dari "announcements", "courseWork", atau "courseWorkMaterials".

Disertakan dengan semua iframe.

ID Lampiran

Nilai attachmentId adalah ID untuk lampiran.

Disertakan dengan iframe teacherViewUri, studentViewUri, dan studentWorkReviewUri.

ID pengiriman

Nilai submissionId adalah ID untuk tugas siswa, tetapi harus digunakan bersama attachmentId untuk mengidentifikasi tugas siswa pada tugas tertentu.

Disertakan dengan studentWorkReviewUri.

Catatan: Anda dapat menggunakan kunci gabungan submissionId dan attachmentId untuk mengidentifikasi tugas siswa jika lampiran yang sama diberikan kepada siswa yang sama di berbagai mata pelajaran. Untuk informasi selengkapnya, lihat konten yang disalin.

Token add-on

Nilai addOnToken adalah token otorisasi yang digunakan untuk membuat

Panggilan addOnAttachments.create untuk membuat add-on.

Disertakan dengan iframe Lampiran Discovery dan iframe Upgrade Link.

URL yang akan diupgrade

Adanya nilai urlToUpgrade menyiratkan bahwa

pengajar telah menyertakan lampiran link dalam tugas, dan telah setuju untuk mengupgradenya ke lampiran add-on. Jika fitur ini belum dikonfigurasi, lihat panduan tentang mengupgrade link ke lampiran add-on untuk mengetahui detail selengkapnya.

Disertakan dengan iframe Upgrade Link.

Parameter terkait login

Parameter kueri login_hint memberikan informasi tentang pengguna Classroom yang mengunjungi halaman web add-on. Parameter kueri ini diberikan di URL src iframe. Pesan ini dikirim saat pengguna sebelumnya telah menggunakan add-on Anda untuk membantu mengurangi hambatan login pengguna akhir. Anda harus menangani parameter kueri ini dalam penerapan add-on.

Petunjuk login

login_hint adalah ID unik untuk ID pengguna

Akun. Setelah pengguna login ke add-on untuk pertama kalinya, parameter login_hint akan diteruskan pada setiap kunjungan berikutnya ke add-on Anda oleh pengguna yang sama.

Ada dua kemungkinan penggunaan parameter login_hint:

1. Teruskan nilai login_hint selama alur autentikasi sehingga pengguna tidak perlu memasukkan kredensialnya saat dialog login muncul. Pengguna tidak login secara otomatis.
2. Setelah pengguna login, gunakan parameter ini untuk membandingkan nilai dengan pengguna yang mungkin sudah login ke add-on. Jika menemukan kecocokan, Anda dapat membiarkan pengguna tersebut login dan tidak menampilkan alur login. Jika parameter tidak cocok dengan pengguna yang login, minta pengguna untuk login dengan tombol login dengan bermerek Google.

Disertakan dengan semua iframe.

Catatan: Informasi tambahan dapat ditemukan tentang penerapan parameter login_hint dan alur login di halaman SSO, Login tanpa hambatan, dan Panduan menangani login berulang.

iframe Penemuan Lampiran

Dimensi	Deskripsi
Wajib	Ya
URI	Disediakan di metadata add-on
Parameter Kueri	courseId, itemId, itemType, addOnToken, dan login_hint.
Tinggi badan	Tinggi jendela 80% dikurangi 60 piksel untuk header atas
Lebar	Maksimum 1600 piksel Lebar jendela 90% saat jendela memiliki lebar <= 600 piksel Lebar jendela 80% saat jendela > lebar 600 piksel

Contoh skenario Penemuan Lampiran

1. Add-on Classroom didaftarkan di Google Workspace Marketplace dengan URI Penemuan Lampiran https://example.com/addon.
2. Pengajar menginstal add-on ini dan membuat pengumuman, tugas, atau materi baru dalam salah satu kursusnya. Misalnya, itemId=234, itemType=courseWork, dan courseId=123.
3. Saat mengonfigurasi item tersebut, pengajar memilih add-on yang baru diinstal sebagai lampiran.
4. Classroom membuat iframe dengan URL src yang disetel ke https://example.com/addon?courseId=123&itemId=234&itemType=courseWork&addOnToken=456.
   1. Pengajar melakukan tugas dalam iframe untuk membuat pilihan lampiran.
5. Pada pemilihan lampiran, add-on akan mengirimkan postMessage ke Classroom untuk menutup iframe.

pengajarViewUri dan iframe StudentViewUri

Dimensi	Deskripsi
Wajib	Ya
URI	teacherViewUri atau studentViewUri
Parameter Kueri	courseId, itemId, itemType, attachmentId, dan login_hint.
Tinggi badan	Tinggi jendela 100% dikurangi 140 piksel untuk header atas
Lebar	Lebar jendela 100%

iframe StudentWorkReviewUri

Dimensi	Deskripsi
Wajib	Tidak (Menentukan apakah ini lampiran jenis aktivitas)
URI	studentWorkReviewUri
Parameter Kueri	courseId, itemId, itemType, attachmentId, submissionId, dan login_hint.
Tinggi badan	Tinggi jendela 100% dikurangi 168 piksel untuk header atas
Lebar	Lebar jendela 100% dikurangi lebar sidebar<> adalah 312 piksel saat diluaskan dan 56 piksel saat diciutkan

Catatan: Pengajar dapat membuka iframe Ulasan Tugas Siswa untuk siswa yang belum pernah melihat lampiran add-on. Dalam hal ini, add-on mungkin belum mengetahui siswa ini dan akan menampilkan pesan yang sesuai.

iframe Upgrade Link

Dimensi	Deskripsi
Wajib	Ya, jika mengupgrade link ke lampiran add-on didukung oleh add-on Anda.
URI	Disediakan di metadata add-on
Parameter Kueri	courseId, itemId, itemType, addOnToken, urlToUpgrade, dan login_hint.
Tinggi badan	Tinggi jendela 80% dikurangi 60 piksel untuk header atas
Lebar	Maksimum 1600 piksel Lebar jendela 90% saat jendela memiliki lebar <= 600 piksel Lebar jendela 80% saat jendela > lebar 600 piksel

Contoh skenario Upgrade Link

1. Add-on Classroom didaftarkan dengan URI Link Upgrade https://example.com/upgrade. Anda telah memberikan pola awalan host dan jalur berikut untuk Lampiran link yang harus diupgrade oleh Classroom ke lampiran add-on:
   • Host-nya adalah example.com dan awalan jalurnya adalah /quiz.
2. Pengajar membuat pengumuman, tugas, atau materi baru dalam salah satu kursusnya. Misalnya, itemId=234, itemType=courseWork, dan courseId=123.
3. Pengajar menempelkan link, https://example.com/quiz/5678, dalam dialog lampiran link yang cocok dengan pola URL yang Anda berikan. Kemudian, pengajar akan diminta untuk mengupgrade Link ke lampiran add-on.

4. Classroom meluncurkan iframe Upgrade Link dengan URL yang ditetapkan ke https://example.com/upgrade?courseId=123&itemId=234&itemType=courseWork&addOnToken=456&urlToUpgrade=https%3A%2F%2Fexample.com%2Fquiz%2F5678.

5. Anda mengevaluasi parameter kueri yang diteruskan di iframe dan melakukan panggilan ke endpoint CreateAddOnAttachment. Perhatikan bahwa parameter kueri urlToUpgrade dienkode URI saat diteruskan pada iframe. Anda perlu mendekode parameter tersebut untuk mendapatkannya dalam bentuk aslinya. Misalnya, JavaScript menawarkan fungsi decodeURIComponent().

6. Setelah berhasil membuat lampiran add-on dari Link, Anda dapat mengirim postMessage ke Classroom untuk menutup iframe.

Tutup iframe

iframe dapat ditutup dari alat pembelajaran dengan mengirimkan postMessage dengan payload {type: 'Classroom', action: 'closeIframe'}. Classroom hanya menerima postMessage ini dari host_name+port yang sesuai dengan URI asli yang dibuka.

<button id="close">Send message to close iframe</button>
<script>
  document.querySelector('#close')
    .addEventListener('click', () => {
        window.parent.postMessage({
            type: 'Classroom',
            action: 'closeIframe',
        }, '*');
    });
</script>

Menutup iframe dari iframe

Domain+port halaman yang mengirimkan peristiwa postMessage harus memiliki domain+port yang sama seperti URI yang digunakan untuk meluncurkan iframe. Jika tidak, pesan akan diabaikan. Solusinya adalah mengalihkan kembali ke halaman di domain asli yang tidak melakukan apa pun selain mengirim peristiwa postMessage.

Menutup iframe dari tab baru

Perlindungan lintas-domain mencegah hal ini berfungsi. Solusinya adalah menangani komunikasi antara iframe dan tab baru secara mandiri dan membiarkan iframe pada akhirnya bertanggung jawab untuk menerbitkan peristiwa tutup postMessage. Sebagai catatan, hyperlink "Buka di Nama Partner" akan dihapus agar pengguna tidak membuat tab dengan cara ini dalam waktu dekat.

Batasan

Semua iframe dibuka dengan atribut sandbox berikut:

• allow-popups
• allow-popups-to-escape-sandbox
• allow-forms
• allow-scripts
• allow-storage-access-by-user-activation
• allow-same-origin

dan kebijakan fitur berikut

• allow="microphone *"

Pemblokiran cookie pihak ketiga

Perlu diketahui bahwa pemblokiran cookie pihak ketiga mempersulit pengelolaan sesi login di iframe. Lihat https://www.cookiestatus.com tentang status pemblokiran cookie saat ini di berbagai browser. Tentu saja, masalah ini tidak hanya terjadi pada add-on Google Classroom dan memengaruhi semua situs yang iframe terhadap pihak ketiga. Banyak partner kami yang telah mengalami masalah ini.

Beberapa solusi umum adalah:

• Buka tab baru untuk membuat cookie dalam konteks pihak pertama. Beberapa browser memberikan akses ke cookie yang dibuat dalam konteks pihak pertama saat dalam konteks pihak ketiga.
• Minta pengguna untuk mengizinkan cookie pihak ketiga. Hal ini mungkin tidak selalu bisa dilakukan oleh semua pengguna.
• Desain aplikasi web satu halaman yang tidak bergantung pada cookie.

Pembatasan cookie lainnya diperkirakan akan tersedia di versi browser mendatang. Buat permintaan fitur untuk mengirim masukan ke Google tentang cara mengurangi peningkatan yang diperlukan oleh partner.

Aktifkan visibilitas add-on menggunakan ekspresi reguler URL

Pengajar sering membuat tugas dengan lampiran link. Untuk mempromosikan penggunaan add-on, Anda dapat menentukan ekspresi reguler yang cocok dengan URL resource yang dapat diakses di add-on Anda. Pengajar yang melampirkan link yang cocok dengan salah satu ekspresi reguler Anda akan melihat dialog yang dapat ditutup yang mendorong mereka untuk mencoba add-on Anda. Pengguna hanya akan melihat dialog ini jika add-on sudah diinstal untuk akun mereka.

Jika Anda ingin memberikan perilaku ini kepada pengajar, berikan ekspresi reguler yang sesuai kepada kontak Google Anda. Jika ekspresi reguler yang Anda berikan terlalu luas atau bertentangan dengan add-on lain, ekspresi reguler tersebut dapat diubah menjadi lebih dibatasi atau berbeda.

Gambar 1. Pengajar memilih lampiran link ke tugas baru.

Gambar 2. Pengajar menempelkan link dari sumber pihak ketiga. Pengajar telah menginstal add-on Classroom pihak ketiga.

Gambar 3. Dialog interaktif yang ditampilkan kepada pengajar jika link yang ditempelkan cocok dengan ekspresi reguler yang ditentukan oleh developer pihak ketiga.

Jika pengajar memilih "Coba sekarang" pada jendela pop-up seperti yang terlihat pada gambar 3, mereka akan dialihkan ke iframe Penemuan Lampiran add-on Anda.