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 Anda perlu menggunakan library Anda sendiri untuk memanggil layanan ini, gunakan informasi berikut saat Anda membuat permintaan API.

Dokumen discovery

Dokumen Discovery adalah spesifikasi yang dapat dibaca komputer 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 berhubungan dengan endpoint layanan ini:

  • https://classroom.googleapis.com

REST Resource: v1.courses

Metode
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Menampilkan apakah pengguna memenuhi syarat untuk membuat lampiran add-on dalam 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 membuat permintaan, yang dibatasi pada 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 mata pelajaran.

REST Resource: 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.

REST Resource: 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.

REST Resource: v1.courses.announcements.addOnAttachments

Metode
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Membuat lampiran add-on di bawah 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 bawah postingan.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

REST Resource: v1.courses.courseWork

Metode
create POST /v1/courses/{courseId}/courseWork
Membuat tugas kursus.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Menghapus tugas kelas.
get GET /v1/courses/{courseId}/courseWork/{id}
Mengembalikan tugas kursus.
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 kursus yang diizinkan untuk dilihat oleh pemohon.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Mengubah mode dan opsi penerima tugas untuk tugas kelas.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Memperbarui satu atau beberapa kolom tugas kelas.

REST Resource: v1.courses.courseWork.addOnAttachments

Metode
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Membuat lampiran add-on di bawah 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 bawah postingan.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

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

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

REST Resource: 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.

REST Resource: v1.courses.courseWork.studentSubmissions

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

REST Resource: 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 kursus yang diizinkan untuk dilihat oleh pemohon.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Memperbarui satu atau beberapa kolom materi tugas mata kuliah.

REST Resource: v1.courses.courseWorkMaterials.addOnAttachments

Metode
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Membuat lampiran add-on di bawah 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 bawah postingan.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

REST Resource: v1.courses.posts

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

REST Resource: v1.courses.posts.addOnAttachments

Metode
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Membuat lampiran add-on di bawah 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 bawah postingan.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Memperbarui lampiran add-on.

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

Metode
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Menampilkan kiriman 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.

REST Resource: 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}
Memperbarui satu atau beberapa kolom dalam grup siswa.

REST Resource: 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.

REST Resource: 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 dalam kursus.
list GET /v1/courses/{courseId}/students
Menampilkan daftar siswa dalam kursus ini yang diizinkan untuk dilihat oleh pemohon.

REST Resource: 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 mata pelajaran ini yang diizinkan untuk dilihat oleh pemohon.

REST Resource: 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}
Mengembalikan 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.

REST Resource: v1.invitations

Metode
accept POST /v1/invitations/{id}:accept
Menerima undangan, menghapusnya, dan menambahkan pengguna yang diundang ke pengajar atau siswa (sebagaimana mestinya) di 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 pada undangan yang cocok dengan permintaan daftar.

REST Resource: v1.registrations

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

REST Resource: 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.

REST Resource: 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 menurut parameter yang diberikan.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Mengubah undangan wali.

REST Resource: 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 pada wali yang cocok dengan permintaan.