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 "Kompatibel dengan Classroom".

Kata kunci "HARUS", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", dan "OPTIONAL" dalam dokumen ini harus ditafsirkan sebagaimana 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 perlu diambil pengguna untuk memperbaiki situasinya. 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 selengkapnya tentang harga atau cara menghubungi staf penjualan. WAJIB
2.0 Login pengguna akhir
  2.1 Pengguna Guru 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 memberikan kecocokan dengan pengguna yang sedang login, add-on HARUS meminta pengguna dengan tombol login dan meneruskan login_hint ke library auth untuk memfilter akun yang tidak valid.
WAJIB
  2,7 Saat pengguna Classroom belum login ke add-on (sebagaimana ditentukan dengan melihat petunjuk login), add-on HARUS menampilkan tombol 'Login dengan Google' untuk tindakan pengguna yang eksplisit guna memicu proses login.
Catatan: Tindakan ini diperlukan untuk memenuhi 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 panduan persetujuan Google Workspace Marketplace umum. WAJIB
  3.2 Jika 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 hanya menggunakan alur kerja add-on dan tidak beralih ke alur kerja kursus atau menggunakan Tombol Berbagi Classroom. WAJIB
  3.4 Pilihan pelokalan: bahasa HARUS didasarkan pada preferensi lokal yang ditetapkan oleh browser jika tersedia. DIREKOMENDASIKAN
  3,5 Jika add-on menetapkan maxPoints, pointsEarned juga HARUS disetel 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 AA level WCAG 2.1 tentang aksesibilitas. Developer add-on akan melaporkan sendiri bahwa persyaratan ini terpenuhi pada saat pengiriman dan add-on tetap sesuai dengan perubahan add-on di 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 kursus yang disalin, add-on TIDAK BOLEH menampilkan halaman error di iframe. WAJIB
  3,12 Jika studentViewUri, teacherViewUri, atau studentWorkViewUri diluncurkan dari tugas yang disalin atau kursus yang disalin, add-on HARUS 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, bukan sebagai lampiran jenis konten. WAJIB
  4,2 Iframe Penemuan Lampiran HARUS menyediakan antarmuka pengguna yang menawarkan setidaknya salah satu hal berikut:
  • Buat konten baru untuk dilampirkan
  • Mencari, 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 melampirkannya ke tugas. WAJIB
  4,5 Jika pengajar perlu 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 memunculkan 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 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 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 peninjauan pengajar dalam iframe. Materi tambahan dapat ditautkan ke 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 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 melakukan 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.0 Diperbarui 30 April 2024
1.1 Menggabungkan 1.1 dan 1.2 ke dalam satu persyaratan.
2.1 Menggabungkan 2.1 dan 2.5 ke dalam satu persyaratan.
2.2 Menggabungkan 2.2, 2.3, dan 2.4 ke dalam satu persyaratan.
3,5 Menggabungkan 3,5, 3,6, dan 3,7 ke dalam satu persyaratan.
3,10 Menambahkan persyaratan bahwa add-on tidak akan 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 Dinomori ulang, sebelumnya 4.2. Juga diubah dari WAJIB menjadi DIREKOMENDASIKAN.
4,4 Dinomori ulang, sebelumnya 4.3.
4,5 Dinomori ulang, sebelumnya 4.4.
5.2 Dinomori ulang, sebelumnya 5.3.
5.3 Dinomori ulang, sebelumnya 5.2.
9.1 Menambahkan rekomendasi untuk mengupgrade link yang ditempelkan ke lampiran.
9.2 Menambahkan persyaratan 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 yang memerlukan penerapan hd.
3.2 Menulis ulang "provide path".
5,5, 5,6, 6,3, 6,4, 7,5, 7,6 Menambahkan salinan kursus yang diperlukan dan panduan yang direkomendasikan untuk studentViewUri, teacherViewUri, dan studentWorkReviewUri.
Versi 0.2 Diperbarui 29 Okt 2021
1,3 Menyesuaikan teks agar lebih jelas dari niatnya.
3.1 Menambahkan "Add-on HARUS mematuhi panduan persetujuan GWM umum yang ditemukan di situsnya".
3.9 WCAG mengubah WAJIB menjadi DIREKOMENDASIKAN.
5.1 Diubah WAJIB menjadi DIREKOMENDASIKAN.
5.3 Menambahkan "Jika add-on muncul dari iframe, HARUS ada pratinjau tentang tugas dalam iframe".
5.4 Menambahkan pesan "Jika add-on muncul dari iframe, SEharusnya 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 seluler siswa diubah dari WAJIB menjadi DIREKOMENDASIKAN.
Versi 0.1 Diperbarui 22 September 2021
  Rilis awal.