Resource API

Panduan ini memberikan ringkasan komponen utama yang membentuk Google Classroom API. Google Classroom API terdiri dari resource dan layanan. Materi mewakili entitas di Google Classroom, seperti kursus atau tugas, dan layanan mengambil serta mengelola materi ini. Beberapa entitas ini memiliki properti tambahan khusus untuk API selain yang ada di Classroom. Jenis entity utama adalah:

Sebagian besar resource memiliki metode layanan untuk operasi standar seperti membaca, memperbarui, dan menghapus instance resource. Beberapa resource juga memiliki metode kustom untuk operasi lain, seperti mengubah daftar siswa yang diberi tugas tertentu.

Untuk informasi mendetail tentang resource dan metode API, lihat Referensi Classroom API.

Ringkasan hubungan resource

• Materi adalah objek data dasar di Google Classroom.
• Alias digunakan sebagai ID alternatif untuk Courses.
• Undangan digunakan untuk mengundang Profil pengguna menjadi Pengajar atau Siswa di Course, tetapi pengguna juga dapat ditambahkan langsung oleh administrator domain Google Workspace for Education.
• Pengajar membuat Item streaming dan membagikannya kepada siswa di kursus mereka. Jenis item streaming yang mungkin adalah Materi Kursus, MateriMateriKursus, dan Pengumuman. CourseWork dan CourseWorkMaterials dapat diselenggarakan secara visual menjadi Topics, dan dapat berisi AddOnAttachments. Siswa mengirimkan StudentSubmissions untuk CourseWork mereka.
• Developer dapat membuat Pendaftaran untuk mendapatkan notifikasi saat beberapa data ini berubah.

Google Classroom tersedia untuk domain yang berlangganan Google Workspace for Education. Domain dalam konteks Classroom biasanya mewakili distrik sekolah. Anda dapat membuat domain pengujian Google Workspace for Education untuk tujuan pengembangan, yang memberi Anda kontrol atas instance produksi Classroom tanpa memengaruhi pengguna sebenarnya.

Kursus dan Alias

Courses mewakili class, seperti "M. Matematika jam ke-4 Smith", serta pengajar, daftar nama siswa, dan metadata yang ditetapkan. Setiap kursus diidentifikasi dengan ID unik yang ditetapkan oleh server. Resource Course secara khusus mengaitkan semua metadata tentang kursus, seperti nama, deskripsi, lokasi, dan waktu. Daftar nama siswa kursus dikelola melalui resource Siswa, Pengajar, dan Undangan serta metodenya.

Aliases adalah ID alternatif untuk kelas yang dapat dikaitkan dengan kursus dan digunakan sebagai pengganti ID unik. Setiap alias ada dalam namespace yang membatasi siapa yang dapat membuatnya dan melihatnya. Dua namespace didukung:

• Domain: Namespace domain berguna untuk membuat alias yang memerlukan akses dari semua pengguna, tetapi tidak spesifik untuk satu program. Misalnya, daftar alternatif untuk kursus, seperti MATH 127 dan COMSCI 127, harus dibuat di namespace domain. Alias di namespace domain hanya dapat dibuat oleh administrator domain, tetapi dapat dilihat oleh semua pengguna di domain.
• Project developer: Namespace project developer berguna untuk mengelola alias khusus untuk aplikasi. Misalnya, aplikasi yang menggunakan ID alternatif untuk kursus dapat membuat alias untuk memetakan ID-nya ke kursus Classroom. Alias yang dibuat di namespace ini terikat dengan Konsol API Google tertentu. Setiap pengguna aplikasi dapat membuat dan melihat alias di namespace untuk project developer aplikasi tersebut.

Untuk informasi selengkapnya tentang cara mengelola metadata dan alias kursus, lihat Mengelola kursus.

Daftar nama dan pengguna kursus

Students dan Teachers adalah pemetaan spesifik antara profil pengguna dan kursus, yang mewakili peran pengguna tersebut dalam kursus. Penunjukan siswa dan pengajar tidak bersifat global: pengguna dapat ditetapkan sebagai pengajar untuk satu kursus dan siswa di kursus lain. Penunjukan "siswa" atau "pengajar" mewakili kumpulan izin untuk pengguna tertentu di kursus tertentu. Kursus dapat memiliki lebih dari satu pengajar atau tidak memiliki siswa. Pengajar dan siswa dapat ditambahkan ke atau dihapus dari kursus kapan saja.

Siswa

Resource Student mewakili pengguna yang terdaftar sebagai siswa di kursus tertentu.

Siswa diizinkan untuk melihat detail dan pengajar kursus untuk kursus tersebut.

Guru

Resource Teacher mewakili pengguna yang mengajar kursus tertentu.

Pengajar diizinkan untuk melihat dan mengubah detail kursus, melihat pengajar dan siswa, serta mengelola pengajar dan siswa tambahan.

Invitations dan metode terkaitnya memberikan cara yang mudah untuk menambahkan siswa dan pengajar ke kursus. Dengan membuat undangan, pengguna dapat memilih apakah akan bergabung ke kursus atau tidak, bukan Anda yang menambahkannya secara langsung melalui materi pengajar dan siswa.

UserProfiles mewakili pemetaan ke profil domain pengguna seperti yang diidentifikasi oleh ID unik atau alamat email pengguna yang ditampilkan oleh Directory API. Pengguna saat ini juga dapat merujuk ke ID mereka sendiri menggunakan singkatan "me".

Layanan UserProfiles juga dapat digunakan untuk mengelola dan mengundang Guardians, yang merupakan pemetaan antara siswa dan wali. Wali di Classroom memiliki akses ke beberapa informasi siswa, seperti tugas mereka.

Untuk mengetahui informasi selengkapnya tentang cara mengelola daftar nama, lihat Mengelola Pengajar dan Siswa.

Streaming item

Item streaming adalah bagian dari konten yang diposting dan dibagikan kepada anggota kursus. Developer dan pengajar dapat membuat tiga jenis item streaming: Announcement, CourseWork, dan CourseWorkMaterial.

Pengajar membuat Announcements di bagian atas halaman Forum di UI Classroom. Pengajar membuat CourseWork dan CourseWorkMaterials dengan mengklik tombol Buat di tab Tugas Kelas. Developer dapat membuat semua jenis item streaming secara terprogram melalui Classroom API.

Hal berikut berlaku untuk item streaming:

• Semua item streaming dapat berisi materi tambahan, seperti file Google Drive, video YouTube, Google Formulir, hyperlink URL, dan lampiran add-on Classroom.
• Semua item forum dapat ditetapkan ke sebagian siswa dalam kursus.
• CourseWork dapat dinilai atau tidak dinilai. Pengajar dapat mengubah status penilaian tugas CourseWork kapan saja.
• Item streaming dapat memiliki lebih dari satu lampiran.
• Item streaming dapat memiliki lampiran dari berbagai jenis. Misalnya, satu tugas CourseWork mungkin memiliki file Google Drive, video YouTube, dan lampiran add-on Classroom secara bersamaan.
• Item streaming mungkin memiliki lampiran add-on dari lebih dari satu developer.
• Developer dapat mendapatkan dan mengubah detail tentang resource item forum yang memiliki salah satu lampiran add-on mereka.
• Developer dapat menyerahkan, mengklaim kembali, atau mengembalikan tugas siswa untuk tugas CourseWork yang menyertakan salah satu lampiran add-on mereka.
• Developer hanya dapat menyelesaikan nilai untuk setiap kiriman siswa dalam tugas yang mereka buat.

Item streaming yang disalin

Pengajar dapat menyalin item streaming dengan menyalin kursus, menggunakan kembali tugas, atau memublikasikan item streaming ke beberapa kursus. Setiap salinan baru akan memiliki ID yang berbeda, yang mungkin merupakan pertimbangan penting jika Anda mengembangkan add-on Classroom. Baca panduan kami tentang konten yang disalin untuk memahami cara add-on menangani skenario ini.

CourseWork dan StudentSubmissions

Item CourseWork mewakili tugas untuk sekelompok siswa dalam kursus. Ini adalah satu-satunya jenis item forum yang dapat menerima kiriman siswa. Resource CourseWork berisi detail seperti deskripsi, batas waktu, nilai maksimum, dan metadata seperti waktu pembuatan.

Setiap resource CourseWork menjelaskan salah satu jenis tugas berikut:

• Tugas yang diselesaikan siswa dengan mengirimkan lembar kerja atau lampiran lainnya.
• Pertanyaan jawaban singkat atau pertanyaan pilihan ganda.

Tugas siswa untuk item CourseWork direpresentasikan oleh StudentSubmission. Respons ini terdiri dari respons dan metadata tambahan seperti status dan nilai yang ditetapkan.

Isi StudentSubmission bergantung pada jenis item CourseWork yang sesuai dan dapat mencakup:

• Spreadsheet dan lampiran yang dikirimkan untuk tugas, termasuk judul, thumbnail, dan URL-nya, serta ID yang dapat digunakan dengan API yang sesuai seperti Drive atau YouTube.
• Respons terhadap pertanyaan jawaban singkat atau pertanyaan pilihan ganda.

Untuk mengetahui informasi selengkapnya tentang cara mengelola tugas kursus dan kiriman siswa, lihat Mengelola tugas kursus.

CourseWorkMaterials dan Pengumuman

Serupa dengan CourseWork, CourseWorkMaterials mewakili konten yang ditetapkan untuk sekelompok siswa dalam kursus. Setiap referensi memiliki detail seperti judul dan deskripsi beserta materi tambahan. Namun, tidak seperti CourseWork, CourseWorkMaterials tidak mengharuskan siswa mengirimkan artefak apa pun. Dengan demikian, tidak ada batas waktu, dan StudentSubmissions tidak ada untuk CourseWorkMaterials. Pengajar dapat menggunakan CourseWorkMaterials untuk memposting bacaan yang disarankan, silabus, atau peraturan kelas.

Announcements juga mewakili konten yang dibagikan kepada sekelompok siswa, tetapi tidak memiliki detail seperti judul, dan tidak dapat diatur menurut Topics seperti CourseWork atau CourseWorkMaterials. Pengajar dapat menggunakannya untuk mengumumkan pengingat atau pemberitahuan kepada kelas.

Topik

Topics digunakan untuk mengatur CourseWork dan CourseWorkMaterials secara visual dalam class. Ini dapat digunakan untuk mengelompokkan tugas menjadi "opsional" dan "wajib", atau "unit 1" dan "unit 2", misalnya.

Add-on Classroom

Add-on adalah UI dan backend yang ditayangkan developer yang biasanya ditampilkan dalam iframe. Add-on muncul sebagai lampiran pada item streaming. Item streaming dapat berupa Announcements, CourseWork, atau CourseWorkMaterials. Lampiran add-on diwakili oleh AddOnAttachment.

Lampiran add-on dapat berupa aktivitas atau konten.

• Lampiran aktivitas mengharuskan siswa menyelesaikan dan menyerahkan kiriman individu. Contohnya mencakup kuis, gambar, atau game. Pengiriman aktivitas dapat dinilai secara opsional.
• Lampiran konten tidak memerlukan pengiriman siswa. Siswa tidak perlu menyerahkan lampiran dan lampiran tersebut tidak dinilai. Contohnya mencakup foto, artikel, dan video.

Lihat panduan pengembangan add-on untuk mengetahui informasi selengkapnya.

Pendaftaran

Aplikasi dapat berlangganan notifikasi saat data tertentu berubah di Google Classroom. Misalnya, saat daftar nama peserta kursus diperbarui. Registrations mewakili petunjuk untuk mengirim notifikasi ini ke aplikasi Anda.

Lihat panduan notifikasi push untuk mempelajari lebih lanjut.