Persyaratan add-on

Versi 1.0, 30 Apr 2024.

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

Kata kunci "HARUS", "TIDAK BOLEH", "DIPERLUKAN", "TIDAK BOLEH", "TIDAK BOLEH", "Seharusnya", "TIDAK BOLEH", "DIREKOMENDASIKAN", "MEI", dan "OPSIONAL" dalam dokumen ini adalah ditafsirkan seperti yang dijelaskan dalam RFC 2119.

Persyaratan

ID Jenis
1.0 Lisensi Pengguna Akhir (jika berlaku)
  1.1 Pesan yang mudah digunakan HARUS ditampilkan kepada pengguna jika pengguna tidak memiliki lisensi. Pesan ini HARUS menyatakan dengan jelas alasan add-on tidak dapat digunakan dan menyarankan tindakan bagi pengguna untuk memperbaiki situasi tersebut. WAJIB
  1,3 Listingan Google Workspace Marketplace add-on HARUS menentukan detail tentang persyaratan pemberian lisensi yang mungkin diperlukan untuk menggunakan add-on. Jika add-on memiliki tingkat berbayar, listingan Marketplace HARUS menyediakan link ke halaman web yang memberikan informasi lebih lanjut tentang harga atau cara menghubungi staf penjualan. WAJIB
2.0 Login pengguna akhir
  2.1 Pengguna Teacher 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 SSO Google untuk memproses login pengguna secara otomatis pada kunjungan berikutnya tanpa menampilkan perintah login.
Jika petunjuk login tidak menghasilkan kecocokan dengan pengguna yang sedang login, add-on HARUS menggunakan tombol login dan meneruskan login_hint ke library autentikasi untuk mengecualikan akun yang tidak valid.
WAJIB
  2,7 Jika pengguna Classroom belum login ke add-on (sebagaimana ditentukan dengan melihat petunjuk login), add-on HARUS menampilkan 'Login dengan Google' untuk tindakan eksplisit pengguna 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 SEHARUSNYA menampilkan siapa pengguna yang saat ini 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 salah satu perjalanan iframe, tugas HARUS memberikan pesan yang mudah digunakan untuk kembali ke Classroom. WAJIB
  3.3 Pengguna HARUS menyelesaikan perjalanan menggunakan alur kerja add-on saja dan tidak beralih ke alur Kerja mata pelajaran atau menggunakan Tombol Berbagi Classroom. WAJIB
  3.4 Pilihan pelokalan: bahasa SEHARUSNYA didasarkan pada preferensi lokal yang disetel oleh browser, jika tersedia. DIREKOMENDASIKAN
  3,5 Jika add-on menentukan maxPoints, add-on juga HARUS menetapkan pointsEarned saat siswa menyelesaikan pengiriman menggunakan kredensial pengajar yang tersimpan (direkomendasikan) ATAU saat pengajar membuka kiriman di iframe Ulasan Tugas Siswa. WAJIB
  3,9 Add-on HARUS mematuhi panduan AA tingkat WCAG 2.1 tentang aksesibilitas. Developer add-on akan melaporkan sendiri bahwa persyaratan ini terpenuhi pada saat pengiriman dan bahwa add-on akan terus sesuai dengan perubahan add-on pada masa mendatang. DIREKOMENDASIKAN
  3,10 Kesalahan apa pun yang dialami oleh pengguna HARUS dapat dibaca manusia. WAJIB
  3,11 Jika studentViewUri, teacherViewUri, atau studentWorkViewUri diluncurkan dari tugas yang disalin atau salinan kursus, add-on TIDAK BOLEH menampilkan halaman error di iframe. WAJIB
  3,12 Jika studentViewUri, teacherViewUri, atau studentWorkViewUri diluncurkan dari tugas yang disalin atau mata pelajaran yang disalin, add-on SEHARUSNYA menampilkan lampiran baru untuk diselesaikan siswa dan TIDAK BOLEH menampilkan respons siswa dari tugas atau kursus sebelumnya di iframe. DIREKOMENDASIKAN
4,0 Penemuan Lampiran
  4,1 Jika lampiran memerlukan kiriman siswa, lampiran HARUS menyertakan studentWorkReviewUri agar diperlakukan sebagai jenis aktivitas dan bukan lampiran jenis konten. WAJIB
  4,2 iframe Penemuan Lampiran HARUS menyediakan antarmuka pengguna yang menawarkan setidaknya salah satu dari hal berikut:
  • Buat 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 tersebut. DIREKOMENDASIKAN
  4,4 Pengajar HARUS dapat melihat pratinjau konten/aktivitas sebelum membuat komitmen untuk melampirkannya ke tugas. WAJIB
  4,5 Jika pengajar perlu membuat konten/aktivitas sebelum dapat dilampirkan, tugas tersebut HARUS diselesaikan dalam iframe. DIREKOMENDASIKAN
5,0 Tampilan Siswa
  5.1 Saat studentViewUri diluncurkan, add-on SEHARUSNYA TIDAK 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 tersebut dalam iframe. WAJIB
  5.3 Jika suatu aktivitas mengharuskan siswa untuk mengambil tindakan untuk menandai tugas sebagai selesai, tombol TIDAK BOLEH diberi label 'Serahkan' untuk menghindari kebingungan dengan tombol Serahkan Classroom. WAJIB
6,0 Tampilan Pengajar
  6.1 Pengajar SEHARUSNYA 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 untuk ditinjau oleh 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 HARUS dilakukan di UI Classroom saja. WAJIB
8,0 Dukungan seluler Classroom
  8.1 Ketika 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, gunakan deep link ke tampilan yang benar. Jika perangkat tidak didukung, pesan HARUS ditampilkan kepada pengguna untuk memberi tahu bahwa ini adalah perangkat yang 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.0 Diperbarui 30 Apr 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 ke dalam satu persyaratan.
3,10 Menambahkan persyaratan bahwa add-on tidak boleh masuk ke dalam status tidak dapat dipulihkan.
3.11, 3.12 Menggabungkan 5.5, 5.6, 6.3, 6.4, 7.5, dan 7.6 menjadi dua baru lainnya.
4,2 Memperluas deskripsi pengalaman Lampiran Penemuan yang dapat diterima.
4.3 Dinomori ulang, sebelumnya menjadi 4.2. Juga diubah dari REQUIRED menjadi DIREKOMENDASIKAN.
4,4 Dinomori ulang, sebelumnya menjadi 4.3.
4,5 Dinomori ulang, sebelumnya menjadi 4.4.
5.2 Dinomori ulang, sebelumnya menjadi 5.3.
5.3 Dinomori ulang, sebelumnya menjadi 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 Memasukkan skenario saat mengimplementasikan hd tidak diperlukan.
3.2 Kata ulang "berikan jalur".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Menambahkan salinan kursus yang diwajibkan dan panduan yang direkomendasikan untuk studentViewUri, teacherViewUri, dan studentWorkReviewUri.
Versi 0.2 Diperbarui 29 Oktober 2021
1,3 Menyesuaikan teks agar lebih jelas dari niat.
3.1 Menambahkan "Add-on HARUS mematuhi panduan persetujuan GWM umum yang ditemukan di situs mereka."
3,9 WCAG mengubah WAJIB menjadi DIREKOMENDASIKAN.
5.1 WAJIB diubah menjadi DIREKOMENDASIKAN.
5.3 Menambahkan "Jika add-on muncul dari iframe, HARUS ada pratinjaunya tentang tugas di iframe."
5.4 Menambahkan "Jika add-on muncul dari iframe, SEHARUSNYA ada prompt bagi siswa untuk kembali ke Classroom."
8.1 Menambahkan "Jika perangkat tidak didukung, pesan HARUS ditampilkan ke untuk memberi tahu mereka bahwa itu adalah perangkat yang tidak didukung dan idealnya, apa perangkat didukung."
8.2 Tugas siswa seluler diubah dari WAJIB menjadi DIREKOMENDASIKAN.
Versi 0.1 Diperbarui 22 September 2021
  Rilis awal.