Persyaratan add-on

Versi 1.0, 30 April 2024.

Kriteria di halaman ini berlaku untuk semua add-on Classroom. Add-on Anda harus memenuhi semua item yang diperlukan dan berlaku agar disetujui untuk dicantumkan di Google Workspace Marketplace dan add-on yang "Berfungsi dengan Classroom".

Kata kunci "HARUS", "TIDAK BOLEH", "WAJIB", "HARUS", "TIDAK BOLEH", "HARUS", "TIDAK BOLEH", "DISARANKAN", "MUNGKIN", dan "OPSIONAL" dalam dokumen ini harus diinterpretasikan seperti yang dijelaskan dalam RFC 2119.

Persyaratan

ID Jenis
1.0 Lisensi Pengguna Akhir (jika ada)
  1.1 Pesan yang mudah digunakan HARUS ditampilkan kepada pengguna jika pengguna tidak memiliki lisensi. Pesan HARUS menyatakan dengan jelas alasan add-on tidak dapat digunakan dan menyarankan tindakan yang harus dilakukan pengguna untuk memperbaiki situasi tersebut. DIREKOMENDASIKAN
  1,3 Listingan Google Workspace Marketplace untuk add-on HARUS menentukan detail tentang persyaratan lisensi dan langganan yang mungkin diperlukan untuk menggunakan add-on. Jika add-on memiliki tingkat berbayar, listingan Marketplace HARUS memberikan link ke halaman web yang menawarkan informasi selengkapnya tentang harga atau cara menghubungi tenaga penjualan. DIREKOMENDASIKAN
2.0 Login pengguna akhir
  2.1 Pengguna Pengajar HARUS login ke add-on menggunakan SSO Google.
Jika pengguna siswa diminta untuk login ke add-on, mereka HARUS login menggunakan SSO Google.
WAJIB
  2.2 Add-on HARUS menggunakan Google SSO untuk otomatis membuat pengguna login pada kunjungan berikutnya tanpa menampilkan perintah login.
Jika petunjuk login tidak cocok dengan pengguna yang saat ini login, add-on HARUS meminta pengguna dengan tombol login dan meneruskan login_hint ke library autentikasi untuk memfilter akun yang tidak valid.
WAJIB
  2,7 Jika pengguna Classroom belum login ke add-on (seperti yang ditentukan dengan melihat petunjuk login), add-on HARUS menampilkan tombol 'Login dengan Google' untuk tindakan pengguna yang eksplisit guna memicu proses login.
Catatan: Hal ini diperlukan untuk memenuhi pedoman branding Google dan juga membantu menghindari pemblokir pop-up.
WAJIB
  2.8 Add-on HARUS menampilkan pengguna yang sedang login. DIREKOMENDASIKAN
3.0 Umum
  3.1 Add-on HARUS mematuhi panduan persetujuan Google Workspace Marketplace umum. WAJIB
  3.2 Jika tugas diluncurkan ke tab atau jendela baru dari perjalanan iframe mana pun, tugas tersebut HARUS memberikan pesan yang mudah digunakan untuk kembali ke Classroom. DIREKOMENDASIKAN
  3.3 Pengguna HANYA BOLEH menyelesaikan perjalanan menggunakan alur kerja add-on dan tidak beralih ke alur kerja courseWork atau menggunakan Tombol Bagikan Classroom. WAJIB
  3.4 Pilihan pelokalan: bahasa HARUS didasarkan pada preferensi lokal yang ditetapkan oleh browser jika tersedia. DIREKOMENDASIKAN
  3,5 Jika menentukan maxPoints, add-on JUGA HARUS menetapkan pointsEarned saat siswa menyelesaikan kiriman menggunakan kredensial pengajar yang tersimpan (direkomendasikan) ATAU saat pengajar membuka kiriman di iframe Ulasan Tugas Siswa. WAJIB
  3,9 Add-on HARUS mematuhi pedoman aksesibilitas WCAG 2.1 level AA. Developer add-on akan melaporkan sendiri bahwa persyaratan ini terpenuhi pada saat pengiriman dan bahwa add-on tersebut akan terus mematuhi perubahan pada add-on di masa mendatang. DIREKOMENDASIKAN
  3,10 Setiap error yang dialami pengguna HARUS dapat dibaca oleh manusia. DIREKOMENDASIKAN
  3.11 Jika studentViewUri, teacherViewUri, atau studentWorkViewUri diluncurkan dari tugas atau kursus yang disalin, add-on TIDAK BOLEH menampilkan halaman error di iframe. WAJIB
4,0 Penemuan Lampiran
  4,1 Jika lampiran memerlukan pengiriman siswa, lampiran HARUS menyertakan studentWorkReviewUri sehingga diperlakukan sebagai jenis aktivitas, bukan lampiran jenis konten. WAJIB
  4,2 Iframe Penemuan Lampiran HARUS menyediakan antarmuka pengguna yang menawarkan setidaknya salah satu hal berikut:
  • Membuat konten baru untuk dilampirkan
  • Menjelajahi, memilih, dan melampirkan dari koleksi konten
  • Petunjuk untuk melampirkan konten dari situs Anda atau produk lainnya
WAJIB
  4.3 Pengajar HARUS dapat menemukan dan mengakses semua konten/aktivitas yang tersedia untuk pengajar. DIREKOMENDASIKAN
  4,4 Pengajar HARUS dapat melihat pratinjau konten/aktivitas sebelum membuat komitmen untuk melampirkan konten/aktivitas tersebut ke tugas. DIREKOMENDASIKAN
  4,5 Jika pengajar memerlukan tugas untuk membuat konten/aktivitas sebelum dapat dilampirkan, tugas tersebut HARUS diselesaikan di iframe. DIREKOMENDASIKAN
5.0 Tampilan Siswa
  5.1 Saat studentViewUri diluncurkan, add-on TIDAK BOLEH mengeluarkan pengguna dari iframe untuk menyelesaikan tugas.
Jika add-on mengeluarkan pengguna dari iframe, HARUS ada pesan atau indikasi lain bagi siswa untuk kembali ke Classroom.
DIREKOMENDASIKAN
  5.2 Jika aktivitas add-on muncul dari iframe, HARUS ada pratinjau tentang tugas di iframe. DIREKOMENDASIKAN
  5.3 Jika ada, tombol atau link dalam aktivitas berlabel Kirim HARUS menyebabkan permintaan API untuk mengirimkan tugas siswa guna ditinjau oleh pengajar. WAJIB
6.0 Tampilan Pengajar
  6.1 Pengajar HARUS dapat melihat apa yang akan dilihat siswa saat mereka mengerjakan tugas. DIREKOMENDASIKAN
7.0 Peninjauan Tugas Siswa
  7.1 Jika studentWorkReviewUri diluncurkan, add-on HARUS merender tugas siswa tersebut untuk ditinjau pengajar dalam iframe. Materi tambahan dapat ditautkan di luar iframe. WAJIB
  7.2 Add-on TIDAK BOLEH mengaktifkan navigasi antar-siswa di tampilan studentWorkReviewUri. Navigasi antar-siswa HANYA boleh dilakukan di UI Classroom. WAJIB
8.0 Dukungan seluler Classroom
  8.1 Saat aplikasi seluler Classroom meluncurkan teacherViewUri, studentViewUri, atau studentWorkReviewUri, URL HARUS membuka aplikasi native seluler partner atau aplikasi web seluler partner, dan dalam kedua kasus tersebut, deep link ke tampilan yang benar. Jika perangkat tidak didukung, pesan HARUS ditampilkan kepada pengguna untuk memberi tahu mereka bahwa perangkat tersebut tidak didukung dan idealnya, perangkat apa yang didukung. WAJIB
  8.2 Tugas siswa HARUS dapat diselesaikan di perangkat seluler. DIREKOMENDASIKAN
9.0 Fitur tambahan
  9.1 Jika pengajar dapat menempelkan link ke konten Anda sebagai Lampiran link, Anda HARUS mengupgrade link ke lampiran add-on. DIREKOMENDASIKAN
  9.2 Jika menggunakan integrasi CourseWork untuk membuat tugas dari luar Classroom, Anda HARUS membuat lampiran add-on secara default untuk semua link yang kompatibel dengan add-on Anda. DIREKOMENDASIKAN

Log perubahan

Versi 1.1 Diperbarui 5 Desember 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 Diubah dari WAJIB menjadi DIUJI.
3,12 Dihapus.
5.3 Diubah susunan katanya. Perubahan terbaru memungkinkan developer add-on menyerahkan kiriman siswa dengan andal menggunakan API.
Versi 1.0 Diperbarui 30 April 2024
1.1 Menggabungkan 1.1 dan 1.2 menjadi satu persyaratan.
2.1 Menggabungkan 2.1 dan 2.5 menjadi satu persyaratan.
2.2 Menggabungkan 2.2, 2.3, dan 2.4 menjadi satu persyaratan.
3,5 Menggabungkan 3.5, 3.6, dan 3.7 menjadi satu persyaratan.
3,10 Menambahkan persyaratan bahwa add-on tidak boleh memasuki status yang tidak dapat dipahami atau tidak dapat dipulihkan.
3.11, 3.12 Menggabungkan 5.5, 5.6, 6.3, 6.4, 7.5, dan 7.6 menjadi dua persyaratan baru.
4,2 Memperluas deskripsi pengalaman Penemuan Lampiran yang dapat diterima.
4.3 Nomornya diubah, sebelumnya 4.2. Juga diubah dari WAJIB menjadi DIUJI.
4,4 Nomornya diubah, sebelumnya 4.3.
4,5 Nomornya diubah, sebelumnya 4.4.
5.2 Nomornya diubah, sebelumnya 5.3.
5.3 Nomornya diubah, sebelumnya 5.2.
9.1 Menambahkan rekomendasi untuk mengupgrade link yang ditempelkan ke lampiran.
9.2 Menambahkan rekomendasi untuk membuat lampiran add-on secara default saat membuat tugas CourseWork secara terprogram.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Dihapus.
Versi 0.3 Diperbarui 22 November 2022
2.3 Koreksi pada panduan petunjuk login.
2,4 Menyertakan skenario yang memerlukan penerapan hd.
3.2 Mengubah kata-kata "berikan jalur".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Menambahkan panduan yang diperlukan dan direkomendasikan untuk salinan kursus untuk studentViewUri, teacherViewUri, dan studentWorkReviewUri.
Versi 0.2 Diperbarui 29 Oktober 2021
1,3 Menyesuaikan teks agar lebih jelas maksudnya.
3.1 Menambahkan "Add-on HARUS mematuhi panduan persetujuan GWM umum yang ditemukan di situsnya".
3,9 WCAG mengubah Wajib menjadi Direkomendasikan.
5.1 Mengubah REQUIRED menjadi RECOMMENDED.
5.3 Menambahkan "Jika add-on muncul dari iframe, HARUS ada pratinjau tentang tugas di iframe."
5.4 Menambahkan "Jika add-on muncul dari iframe, HARUS ada perintah bagi siswa untuk kembali ke Classroom".
8.1 Menambahkan "Jika perangkat tidak didukung, pesan HARUS ditampilkan kepada pengguna untuk memberi tahu mereka bahwa perangkat tersebut tidak didukung dan idealnya, perangkat apa yang didukung."
8.2 Tugas siswa seluler diubah dari WAJIB menjadi DISARANKAN.
Versi 0.1 Diperbarui 22 September 2021
  Rilis awal.