Google Classroom API

Mengelola kelas, daftar nama siswa, dan undangan di Google Classroom.

Layanan: classroom.googleapis.com

Untuk memanggil layanan ini, sebaiknya gunakan library klien yang disediakan Google. Jika aplikasi perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca mesin untuk mendeskripsikan dan menggunakan REST API. Dokumen ini digunakan untuk membuat library klien, plugin IDE, dan alat lainnya yang berinteraksi dengan Google API. Satu layanan dapat menyediakan beberapa dokumen discovery. Layanan ini menyediakan dokumen discovery berikut:

Endpoint layanan

Endpoint layanan adalah URL dasar yang menentukan alamat jaringan layanan API. Satu layanan dapat memiliki beberapa endpoint layanan. Layanan ini memiliki endpoint layanan berikut dan semua URI di bawah didasarkan pada endpoint layanan ini:

  • https://classroom.googleapis.com

Resource REST: v1.courses

Metode
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Menampilkan apakah pengguna memenuhi syarat untuk membuat lampiran add-on di kursus tertentu.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Menampilkan apakah pengguna memenuhi syarat untuk memperbarui GradingPeriodSettings dalam kursus tertentu.
create POST /v1/courses
Membuat kursus.
delete DELETE /v1/courses/{id}
Menghapus kursus.
get GET /v1/courses/{id}
Menampilkan kursus.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Menampilkan setelan periode penilaian dalam kursus.
list GET /v1/courses
Menampilkan daftar kursus yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk kursus yang cocok dengan permintaan.
patch PATCH /v1/courses/{id}
Memperbarui satu atau beberapa kolom dalam kursus.
update PUT /v1/courses/{id}
Memperbarui kursus.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Memperbarui setelan periode penilaian kursus.

Resource REST: v1.courses.aliases

Metode
create POST /v1/courses/{courseId}/aliases
Membuat alias untuk kursus.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Menghapus alias kursus.
list GET /v1/courses/{courseId}/aliases
Menampilkan daftar alias untuk kursus.

Resource REST: v1.courses.announcements

Metode
create POST /v1/courses/{courseId}/announcements
Membuat pengumuman.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Menghapus pengumuman.
get GET /v1/courses/{courseId}/announcements/{id}
Menampilkan pengumuman.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.
list GET /v1/courses/{courseId}/announcements
Menampilkan daftar pengumuman yang diizinkan untuk dilihat oleh pemohon.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Mengubah mode dan opsi penerima tugas pengumuman.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Memperbarui satu atau beberapa kolom pengumuman.

Resource REST: v1.courses.announcements.addOnAttachments

Metode
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Membuat lampiran add-on di postingan.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Menghapus lampiran add-on.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Menampilkan lampiran add-on.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Menampilkan semua lampiran yang dibuat oleh add-on di postingan.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

Resource REST: v1.courses.courseWork

Metode
create POST /v1/courses/{courseId}/courseWork
Membuat tugas kelas.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Menghapus tugas kelas.
get GET /v1/courses/{courseId}/courseWork/{id}
Mengembalikan tugas kelas.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.
list GET /v1/courses/{courseId}/courseWork
Menampilkan daftar tugas yang diizinkan untuk dilihat oleh pemohon.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Mengubah mode dan opsi penerima tugas mata pelajaran.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Mengupdate satu atau beberapa kolom tugas kelas.

Resource REST: v1.courses.courseWork.addOnAttachments

Metode
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Membuat lampiran add-on di postingan.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Menghapus lampiran add-on.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Menampilkan lampiran add-on.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Menampilkan semua lampiran yang dibuat oleh add-on di postingan.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

Resource REST: v1.courses.courseWork.addOnAttachments.studentSubmissions

Metode
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Menampilkan tugas siswa untuk lampiran add-on.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions
Menampilkan daftar tugas siswa yang diizinkan untuk dilihat oleh pemohon.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Memperbarui data yang terkait dengan pengiriman lampiran add-on.

Resource REST: v1.courses.courseWork.rubrics

Metode
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Membuat rubrik.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Menghapus rubrik.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Menampilkan rubrik.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Menampilkan daftar rubrik yang diizinkan untuk dilihat oleh pemohon.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Memperbarui rubrik.

Resource REST: v1.courses.courseWork.studentSubmissions

Metode
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Mengembalikan tugas siswa.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
Menampilkan daftar tugas siswa yang diizinkan untuk dilihat oleh pemohon, dengan mempertimbangkan cakupan OAuth permintaan.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Mengubah lampiran tugas yang dikirimkan siswa.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Memperbarui satu atau beberapa kolom tugas siswa.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Mengklaim kembali kiriman siswa atas nama siswa yang memilikinya.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Mengembalikan tugas siswa.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Menyerahkan kiriman siswa.

Resource REST: v1.courses.courseWorkMaterials

Metode
create POST /v1/courses/{courseId}/courseWorkMaterials
Membuat materi tugas kelas.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Menghapus materi tugas kelas.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Menampilkan materi tugas kelas.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.
list GET /v1/courses/{courseId}/courseWorkMaterials
Menampilkan daftar materi tugas yang diizinkan untuk dilihat oleh pemohon.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Memperbarui satu atau beberapa kolom materi tugas kelas.

Resource REST: v1.courses.courseWorkMaterials.addOnAttachments

Metode
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Membuat lampiran add-on di postingan.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Menghapus lampiran add-on.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Menampilkan lampiran add-on.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Menampilkan semua lampiran yang dibuat oleh add-on di postingan.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

Resource REST: v1.courses.posts

Metode
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.

Resource REST: v1.courses.posts.addOnAttachments

Metode
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Membuat lampiran add-on di postingan.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Menghapus lampiran add-on.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Menampilkan lampiran add-on.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Menampilkan semua lampiran yang dibuat oleh add-on di postingan.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

Resource REST: v1.courses.posts.addOnAttachments.studentSubmissions

Metode
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Menampilkan tugas siswa untuk lampiran add-on.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Memperbarui data yang terkait dengan pengiriman lampiran add-on.

Resource REST: v1.courses.studentGroups

Metode
create POST /v1/courses/{courseId}/studentGroups
Membuat grup siswa untuk kursus.
delete DELETE /v1/courses/{courseId}/studentGroups/{id}
Menghapus grup siswa.
list GET /v1/courses/{courseId}/studentGroups
Menampilkan daftar grup dalam kursus.
patch PATCH /v1/courses/{courseId}/studentGroups/{id}
Mengupdate satu atau beberapa kolom dalam grup siswa.

Resource REST: v1.courses.studentGroups.studentGroupMembers

Metode
create POST /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Membuat anggota grup siswa untuk grup siswa.
delete DELETE /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers/{userId}
Menghapus anggota grup siswa.
list GET /v1/courses/{courseId}/studentGroups/{studentGroupId}/studentGroupMembers
Menampilkan daftar siswa dalam grup.

Resource REST: v1.courses.students

Metode
create POST /v1/courses/{courseId}/students
Menambahkan pengguna sebagai siswa kursus.
delete DELETE /v1/courses/{courseId}/students/{userId}
Menghapus siswa dari kursus.
get GET /v1/courses/{courseId}/students/{userId}
Menampilkan siswa dari kursus.
list GET /v1/courses/{courseId}/students
Menampilkan daftar siswa kursus ini yang diizinkan untuk dilihat oleh pemohon.

Resource REST: v1.courses.teachers

Metode
create POST /v1/courses/{courseId}/teachers
Membuat pengajar kursus.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Menghapus pengajar yang ditentukan dari kursus yang ditentukan.
get GET /v1/courses/{courseId}/teachers/{userId}
Menampilkan pengajar kursus.
list GET /v1/courses/{courseId}/teachers
Menampilkan daftar pengajar kursus ini yang diizinkan untuk dilihat oleh pemohon.

Resource REST: v1.courses.topics

Metode
create POST /v1/courses/{courseId}/topics
Membuat topik.
delete DELETE /v1/courses/{courseId}/topics/{id}
Menghapus topik.
get GET /v1/courses/{courseId}/topics/{id}
Menampilkan topik.
list GET /v1/courses/{courseId}/topics
Menampilkan daftar topik yang diizinkan untuk dilihat oleh pemohon.
patch PATCH /v1/courses/{courseId}/topics/{id}
Memperbarui satu atau beberapa kolom topik.

Resource REST: v1.invitations

Metode
accept POST /v1/invitations/{id}:accept
Menerima undangan, menghapusnya, dan menambahkan pengguna yang diundang ke pengajar atau siswa (sebagaimana mestinya) dari kursus yang ditentukan.
create POST /v1/invitations
Membuat undangan.
delete DELETE /v1/invitations/{id}
Menghapus undangan.
get GET /v1/invitations/{id}
Menampilkan undangan.
list GET /v1/invitations
Menampilkan daftar undangan yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk undangan yang cocok dengan permintaan daftar.

Resource REST: v1.registrations

Metode
create POST /v1/registrations
Membuat Registration, yang menyebabkan Classroom mulai mengirimkan notifikasi dari feed yang disediakan ke tujuan yang disediakan di cloudPubSubTopic.
delete DELETE /v1/registrations/{registrationId}
Menghapus Registration, sehingga Classroom berhenti mengirimkan notifikasi untuk Registration tersebut.

Resource REST: v1.userProfiles

Metode
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Menampilkan apakah pengguna dapat menggunakan kemampuan Classroom yang ditentukan.
get GET /v1/userProfiles/{userId}
Menampilkan profil pengguna.

Resource REST: v1.userProfiles.guardianInvitations

Metode
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Membuat undangan wali, dan mengirim email kepada wali yang meminta mereka untuk mengonfirmasi bahwa mereka adalah wali siswa.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Menampilkan undangan wali tertentu.
list GET /v1/userProfiles/{studentId}/guardianInvitations
Menampilkan daftar undangan wali yang diizinkan untuk dilihat oleh pengguna yang meminta, yang difilter berdasarkan parameter yang diberikan.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Mengubah undangan wali.

Resource REST: v1.userProfiles.guardians

Metode
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Menghapus wali.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Menampilkan wali tertentu.
list GET /v1/userProfiles/{studentId}/guardians
Menampilkan daftar wali yang diizinkan untuk dilihat oleh pengguna yang meminta, yang dibatasi untuk wali yang cocok dengan permintaan.