Struktur API

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

Entitas	Representasi di Classroom
Kursus	Class, seperti "M. Matematika jam ke-4 Smith".
Alias	ID alternatif untuk kursus.
Undangan	Cara menambahkan pengguna ke kelas.
Siswa	Seorang siswa di kelas.
Teachers	Pengajar di kelas.
Profil pengguna	Pengguna secara lebih umum, di luar konteks siswa atau pengajar.
CourseWork	Tugas di kelas.
StudentSubmissions	Siswa mengerjakan tugas tertentu, seperti jawaban atau lembar kerja.
CourseWorkMaterials	Materi untuk siswa di kelas.
Pengumuman	Pengumuman kepada siswa di kelas.
AddOnAttachment	Konten atau aktivitas pada tugas atau materi yang biasanya ditampilkan sebagai iframe sematan.
Topik	Pengelompokan visual tugas dan materi di kelas.
Pendaftaran	Petunjuk untuk mengirim notifikasi ke aplikasi Anda terkait perubahan data, seperti daftar nama siswa kelas.

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, MateriKursus, 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 di 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 dalam 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 siswa dan pengguna kursus

Students dan Teachers adalah pemetaan spesifik antara profil pengguna dan kursus, yang mewakili peran pengguna tersebut dalam kursus. Penetapan 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.

Siswa

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

Siswa diizinkan untuk melihat detail kursus dan pengajar 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 informasi selengkapnya tentang mengelola daftar nama siswa, lihat Mengelola Pengajar dan Siswa.

Tugas mata pelajaran dan kiriman siswa

Item CourseWork mewakili satu tugas yang diberikan kepada sekelompok siswa dalam kursus. Tugas berisi detail seperti deskripsi, batas waktu, dan materi serta metadata seperti waktu pembuatan. Materi mencakup judul, thumbnail, dan URL, serta ID yang dapat digunakan dengan API yang sesuai (yaitu Drive, YouTube).

Item 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.

Konten StudentSubmission bergantung pada jenis item CourseWork yang sesuai:

• 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 dan kiriman siswa, lihat Mengelola Tugas.

Materi dan pengumuman tugas mata pelajaran

Serupa dengan CourseWork, CourseWorkMaterials mewakili konten yang ditetapkan untuk sekelompok siswa dalam kursus, dengan detail seperti judul dan deskripsi, beserta materi. Namun, tidak seperti CourseWork, CourseWorkMaterials tidak memerlukan siswa untuk 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, misalnya.

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. Misalnya, ini dapat digunakan untuk mengelompokkan tugas menjadi "opsional" dan "wajib", atau "unit 1" dan "unit 2".

Add-on Classroom

Add-on adalah UI dan backend yang ditayangkan developer yang biasanya ditampilkan dalam iframe. Add-on muncul sebagai lampiran di 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 termasuk 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 kursus diperbarui. Registrations mewakili petunjuk untuk mengirim notifikasi ini ke aplikasi Anda.

Lihat panduan notifikasi push untuk mempelajari lebih lanjut.