Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat dokumentasi add-on untuk informasi selengkapnya.

Halaman ini diterjemahkan oleh Cloud Translation API.

Google Classroom API

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

Resource REST: v1.courses
Resource REST: v1.courses.aliases
Resource REST: v1.courses.announcements
Resource REST: v1.courses.announcements.addOnLampirans
Resource REST: v1.courses.courseWork
Resource REST: v1.courses.courseWork.addOnLampirans
Resource REST: v1.courses.courseWork.addOnLampirans.studentSubmissions
Resource REST: v1.courses.courseWork.rubrics
Resource REST: v1.courses.courseWork.studentSubmissions
Resource REST: v1.courses.courseWorkMaterials
Resource REST: v1.courses.courseWorkMaterials.addOnLampirans
Resource REST: v1.courses.postingan
Resource REST: v1.courses.postingan.addOnLampirans
Resource REST: v1.courses.postingan.addOnLampirans.studentSubmissions
Resource REST: v1.courses.students
Resource REST: v1.courses.teachers
Resource REST: v1.courses.topics
Resource REST: v1.Invitations
Resource REST: v1.registrations
Resource REST: v1.userProfiles
Resource REST: v1.userProfiles.guardianInvitation
Resource REST: v1.userProfiles.guardians

Layanan: classroom.googleapis.com

Untuk memanggil layanan ini, sebaiknya Anda menggunakan library klien yang disediakan Google. Jika aplikasi Anda 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 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:

https://classroom.googleapis.com/$discovery/rest?version=v1

Endpoint layanan

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

https://classroom.googleapis.com

Resource REST: v1.courses

Metode
`checkAddOnCreationEligibility`	`GET /v1/courses/{courseId}:checkAddOnCreationEligibility` Menampilkan apakah pengguna memenuhi syarat untuk membuat lampiran add-on di kursus tertentu.
`checkGradingPeriodsSetupEligibility`	`GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20240401_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Menampilkan apakah pengguna memenuhi syarat untuk memperbarui GradingPeriodSettings di 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` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20240401_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Menampilkan setelan periode penilaian dalam kursus.
`list`	`GET /v1/courses` Menampilkan daftar kursus yang boleh 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` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20240401_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. 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 boleh dilihat pemohon.
`modifyAssignees`	`POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees` Memodifikasi mode penerima tugas dan opsi 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 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.

Resource REST: v1.courses.courseWork

Metode
`create`	`POST /v1/courses/{courseId}/courseWork` Membuat tugas kursus.
`delete`	`DELETE /v1/courses/{courseId}/courseWork/{id}` Menghapus tugas kursus.
`get`	`GET /v1/courses/{courseId}/courseWork/{id}` Menampilkan 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 boleh dilihat pemohon.
`modifyAssignees`	`POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees` Memodifikasi mode penerima tugas dan opsi tugas.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{id}` Memperbarui satu atau beberapa kolom tugas kursus.

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

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

Resource REST: v1.courses.courseWork.rubrics

Metode
`create`	`POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20231110_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Membuat rubrik.
`delete`	`DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20231110_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Menghapus rubrik.
`get`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20231110_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Menampilkan rubrik.
`list`	`GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20231110_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Menampilkan daftar rubrik yang diizinkan untuk dilihat pemohon.
`patch`	`PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}` Pratinjau Developer: Tersedia sebagai bagian dari Program Pratinjau Developer Google Workspace, yang memberikan akses awal ke fitur tertentu. Fitur ini tersedia di `V1_20231110_PREVIEW` dan yang lebih baru. Lihat Mengakses API Pratinjau untuk mempelajari lebih lanjut. Memperbarui rubrik.

Resource REST: 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 pemohon, dengan mempertimbangkan cakupan OAuth permintaan.
`modifyAttachments`	`POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments` Memodifikasi 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 kembali 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 tugas yang dikirimkan siswa.

Resource REST: v1.courses.courseWorkMaterials

Metode
`create`	`POST /v1/courses/{courseId}/courseWorkMaterials` Membuat materi tugas kursus.
`delete`	`DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}` Menghapus materi tugas kursus.
`get`	`GET /v1/courses/{courseId}/courseWorkMaterials/{id}` Menampilkan materi tugas kursus.
`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 boleh dilihat pemohon.
`patch`	`PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}` Memperbarui satu atau beberapa kolom materi tugas kursus.

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

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

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

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 kursus.
`get`	`GET /v1/courses/{courseId}/students/{userId}` Menampilkan siswa kursus.
`list`	`GET /v1/courses/{courseId}/students` Menampilkan daftar siswa mata pelajaran ini yang boleh dilihat 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 tertentu 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 boleh dilihat 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, menghapus undangan tersebut dan menambahkan pengguna yang diundang ke pengajar atau siswa (sebagaimana diperlukan) 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 boleh 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 mengirim notifikasi dari `feed` yang disediakan ke tujuan yang disediakan di `cloudPubSubTopic`.
`delete`	`DELETE /v1/registrations/{registrationId}` Menghapus `Registration`, yang menyebabkan Classroom berhenti mengirim notifikasi untuk `Registration` tersebut.

Resource REST: v1.userProfiles

Metode
`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 ke wali untuk meminta konfirmasi 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 boleh dilihat oleh pengguna yang meminta, yang difilter menurut parameter yang diberikan.
`patch`	`PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}` Memodifikasi 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 boleh dilihat oleh pengguna yang meminta, yang dibatasi untuk wali yang cocok dengan permintaan.