Persyaratan add-on

Versi 1.1, 5 Desember 2024.

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

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

Persyaratan

ID Jenis
1.0 Lisensi pengguna akhir (jika ada)
  1.1 Pesan yang mudah dipahami PENGGUNA HARUS ditampilkan kepada pengguna saat pengguna tidak memiliki lisensi. Pesan HARUS menyatakan dengan jelas alasan add-on tidak dapat digunakan dan menyarankan tindakan yang harus dilakukan pengguna untuk mengatasi 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 paket berbayar, listingan Marketplace HARUS menyediakan link ke halaman web yang menawarkan informasi lebih lanjut tentang harga atau cara menghubungi tenaga penjual. DIREKOMENDASIKAN
2.0 Login pengguna akhir
  2.1 Pengguna dengan peran Pengajar HARUS login ke add-on menggunakan SSO Google.
Jika pengguna dengan peran siswa diminta untuk login ke add-on, mereka HARUS login menggunakan SSO Google.
WAJIB
  2.2 Add-on HARUS menggunakan SSO Google untuk otomatis membuat pengguna login pada kunjungan berikutnya tanpa menampilkan perintah login.
Jika petunjuk login tidak menghasilkan kecocokan dengan pengguna yang saat ini login, add-on HARUS meminta pengguna untuk login 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' agar tindakan pengguna yang jelas dapat memicu proses login.
Catatan: Hal ini diperlukan untuk mematuhi pedoman branding Google dan juga membantu menghindari pemblokir pop-up.
WAJIB
  2.8 Add-on HARUS menampilkan siapa pengguna yang saat ini login. DIREKOMENDASIKAN
3.0 Umum
  3.1 Add-on HARUS mematuhi pedoman persetujuan umum Google Workspace Marketplace. WAJIB
  3.2 Jika tugas diluncurkan ke tab atau jendela baru dari salah satu perjalanan iframe, 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 add-on menentukan maxPoints, add-on tersebut JUGA HARUS menetapkan pointsEarned saat siswa menyelesaikan kiriman menggunakan kredensial pengajar yang disimpan (direkomendasikan) ATAU saat pengajar membuka kiriman di iframe Peninjauan 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 dipenuhi pada saat pengiriman dan bahwa add-on terus mematuhi perubahan mendatang pada add-on. DIREKOMENDASIKAN
  3,10 Semua error yang dialami pengguna HARUS dapat dibaca oleh manusia. DIREKOMENDASIKAN
  3.11 Jika studentViewUri, teacherViewUri, atau studentWorkViewUri diluncurkan dari tugas yang disalin 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 agar 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 pustaka konten
  • Petunjuk untuk melampirkan konten dari situs atau produk lain Anda
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 memutuskan untuk melampirkannya ke tugas. DIREKOMENDASIKAN
  4,5 Jika pengajar perlu melakukan tindakan untuk membuat konten/aktivitas sebelum dapat dilampirkan, tindakan 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 keluar dari iframe, HARUS ada pratinjau tentang tugas di iframe. DIREKOMENDASIKAN
  5.3 Jika ada, tombol atau link di aktivitas yang berlabel Serahkan HARUS menyebabkan permintaan API untuk mengirimkan tugas siswa agar ditinjau oleh pengajar. WAJIB
6.0 Tampilan Pengajar
  6.1 Pengajar HARUS dapat melihat apa yang akan dilihat siswa saat 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 dalam 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, link dalam harus mengarah 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 saja 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 Anda menggunakan integrasi CourseWork untuk membuat tugas dari luar Classroom, Anda SEBAIKNYA 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 DIREKOMENDASIKAN.
3.12 Dihapus.
5.3 Diformulasikan ulang. Perubahan terbaru memungkinkan developer add-on untuk menyerahkan kiriman siswa secara 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 pernah 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 Diberi nomor ulang, sebelumnya 4.2. Juga diubah dari WAJIB menjadi DIREKOMENDASIKAN.
4,4 Diberi nomor baru, sebelumnya 4.3.
4,5 Diberi nomor ulang, sebelumnya 4.4.
5.2 Diberi nomor baru, sebelumnya 5.3.
5.3 Diberi nomor ulang, 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 Nov 2022
2.3 Koreksi pada panduan petunjuk login.
2,4 Menyertakan skenario saat penerapan hd diperlukan.
3.2 Mengubah kata-kata "provide path".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Menambahkan panduan wajib dan yang direkomendasikan untuk penyalinan kursus bagi studentViewUri, teacherViewUri, dan studentWorkReviewUri.
Versi 0.2 Diperbarui 29 Oktober 2021
1,3 Mengubah teks agar maksudnya lebih jelas.
3.1 Menambahkan "Add-on HARUS mematuhi pedoman persetujuan GWM umum yang ada di situs mereka."
3,9 WCAG mengubah WAJIB menjadi DIREKOMENDASIKAN.
5.1 Mengubah WAJIB menjadi DIREKOMENDASIKAN.
5.3 Menambahkan "Jika add-on keluar dari iframe, HARUS ada pratinjau tentang tugas di iframe."
5.4 Menambahkan "Jika add-on keluar dari iframe, AKAN 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 yang didukung."
8.2 Tugas siswa di perangkat seluler diubah dari WAJIB menjadi DISARANKAN.
Versi 0.1 Diperbarui 22 September 2021
  Rilis awal.