Ringkasan

Classroom API menyediakan antarmuka RESTful bagi Anda untuk mengelola kursus dan daftar nama siswa di Google Classroom. Selain itu, tombol berbagi Classroom memungkinkan developer dan pemilik konten mengaktifkan berbagi konten mereka ke Classroom.

Siapa yang dapat menggunakan API?

Administrator domain Google Workspace for Education dapat menggunakan API untuk menyediakan kursus secara terprogram atas nama pengajar, menyinkronkan sistem informasi siswa dengan Classroom, dan mendapatkan visibilitas dasar ke kelas yang diajarkan di domain mereka.

Developer aplikasi dapat menggunakan Classroom API untuk mengintegrasikan aplikasi mereka dengan Classroom. Aplikasi ini harus menggunakan OAuth 2.0 untuk meminta izin agar dapat melihat kelas dan daftar nama siswa dari pengajar. Admin dapat membatasi apakah pengajar dan siswa dalam domain mereka dapat mengizinkan aplikasi untuk mengakses data Google Classroom.

Pemilik situs dan developer konten dapat menggunakan tombol berbagi Classroom untuk memungkinkan siswa dan pengajar berbagi konten kembali ke Classroom.

Semua integrasi tombol berbagi API dan Classroom harus mengikuti panduan merek Classroom.

Ringkasan API

Classroom API terdiri dari beberapa jenis entity yang sesuai dengan class, pengajar, dan siswa di antarmuka Classroom. Beberapa entity ini memiliki properti tambahan khusus untuk API, selain yang ada di Classroom. Jenis entity utama adalah:

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

Metadata dan alias kursus

Kursus mewakili kelas, seperti "M. Matematika periode ke-4 Smith", dan pengajar, daftar nama siswa, dan metadata yang ditugaskan. Setiap kursus diidentifikasi oleh ID unik yang ditetapkan oleh server. Resource Kursus secara khusus mengenkapsulasi semua metadata tentang kursus, seperti nama, deskripsi, lokasi, dan waktu. Daftar nama kursus dikelola melalui referensi Siswa, Pengajar, dan Undangan serta metodenya.

Alias adalah ID alternatif untuk class yang dapat dikaitkan dengan kursus dan digunakan sebagai pengganti ID unik. Setiap alias ada di namespace yang membatasi siapa yang dapat membuat dan melihatnya. Ada dua namespace yang didukung:

  • Domain: Namespace domain berguna untuk membuat alias yang dapat diakses oleh semua pengguna, tetapi tidak spesifik untuk satu program apa pun. Misalnya, listingan alternatif untuk kursus, seperti MATH 127 dan COMSCI 127, harus dibuat di namespace domain. Alias di namespace domain hanya bisa dibuat oleh administrator domain, tetapi bisa dilihat oleh semua pengguna di sebuah domain.
  • Project developer: Namespace project developer berguna untuk mengelola alias khusus 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 akan dikaitkan dengan Konsol API Google khusus. Setiap pengguna aplikasi dapat membuat dan melihat alias dalam namespace untuk project developer aplikasi tersebut.

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

Daftar nama siswa dan pengguna kursus

Siswa dan Pengajar 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 satu siswa di kursus lainnya. Penetapan "siswa" atau "pengajar" merepresentasikan sekumpulan izin untuk pengguna tertentu dalam kursus tertentu.

Siswa

Referensi Siswa mewakili pengguna yang terdaftar sebagai siswa di

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

Guru

Referensi Pengajar mewakili pengguna yang mengajar kursus tertentu.

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

Undangan 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 langsung menambahkannya melalui referensi 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".

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

Tugas mata pelajaran dan kiriman siswa

Item CourseWork mewakili satu tugas yang diberikan ke sekelompok siswa dalam kursus. Kartu ini 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 diwakili oleh studentSubmission. Class ini terdiri dari respons dan metadata tambahan seperti status dan nilai yang ditetapkan.

Konten StudentSubmission bergantung pada jenis item CourseWork yang sesuai:

  • Lembar kerja dan lampiran yang dikirimkan untuk tugas, termasuk judul, thumbnail, dan URL, 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 mata pelajaran dan kiriman siswa, lihat Mengelola Tugas Kelas.

Add-on Classroom

Add-on adalah UI yang disediakan partner dan backend yang biasanya ditampilkan di iframe. Add-on muncul sebagai lampiran pada postingan, yang dapat berupa Announcements, CourseWork, atau CourseWorkMaterials.

Lampiran add-on dapat berupa aktivitas atau konten.

  • Lampiran aktivitas mengharuskan siswa untuk menyelesaikan dan menyerahkan tugas satu per satu. Contohnya mencakup kuis, gambar, atau game. Kiriman aktivitas dapat dinilai.
  • Lampiran konten tidak memerlukan kiriman siswa. Siswa tidak perlu menyerahkan lampiran dan tidak akan dinilai. Contohnya meliputi foto, artikel, dan video.

Lihat panduan pengembangan add-on untuk mengetahui informasi selengkapnya.

Panduan Memulai

Untuk menyiapkan lingkungan Anda dan langsung mulai menggunakan API, coba salah satu panduan memulai:

Bereksperimen dengan Penjelajah API Google

Untuk bereksperimen metode panggilan pada data live, coba gunakan Penjelajah Google API. Anda tidak perlu menulis kode untuk memulai, namun perhatikan bahwa tindakan yang Anda lakukan menggunakan Penjelajah API dapat mengubah data yang ada.

Salah satu cara untuk mulai memanggil metode adalah dengan melakukan panggilan ke metode courses.list(). Metode ini tidak memerlukan parameter permintaan apa pun dan Anda dapat mengambil id dari daftar kursus yang ditampilkan untuk digunakan sebagai parameter permintaan untuk panggilan API lainnya. Jika belum memiliki kursus, Anda dapat membuatnya menggunakan metode courses.create().

Anda juga dapat mempelajari referensi API.