REST Resource: courses

Resource: Kursus

Kursus di Classroom.

Representasi JSON 
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  }
}
Kolom
id

string

ID untuk kursus ini yang ditetapkan oleh Classroom.

Saat creating a course, Anda dapat menetapkan ID ini ke alias string dalam permintaan untuk membuat alias yang sesuai. id masih ditetapkan oleh Classroom dan tidak dapat diperbarui setelah kursus dibuat.

Menentukan kolom ini dalam mask update kursus akan menyebabkan error.
name

string

Nama kursus. Misalnya, "10th Grade Biology". Nama wajib diisi. Panjangnya harus antara 1 dan 750 karakter serta string UTF-8 yang valid.
section

string

Bagian kursus. Misalnya, "Periode 2". Jika ditetapkan, kolom ini harus berupa string UTF-8 yang valid dan tidak lebih dari 2.800 karakter.
descriptionHeading

string

Judul opsional untuk deskripsi. Misalnya, "Selamat datang di Biologi Kelas 10". Jika ditetapkan, kolom ini harus berupa string UTF-8 yang valid dan tidak lebih dari 3.600 karakter.
description

string

Deskripsi opsional. Misalnya, "Kita akan mempelajari struktur makhluk hidup dari kombinasi buku teks, kuliah tamu, dan kerja lab. Semoga Anda bersemangat." Jika ditetapkan, kolom ini harus berupa string UTF-8 yang valid dan tidak lebih dari 30.000 karakter.
room

string

Lokasi ruang opsional. Misalnya, "301". Jika ditetapkan, kolom ini harus berupa string UTF-8 yang valid dan tidak lebih dari 650 karakter.
ownerId

string

ID pemilik kursus.

Jika ditentukan sebagai parameter create course request, kolom ini wajib diisi. ID dapat berupa salah satu dari hal berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta

ID ini harus ditetapkan dalam permintaan pembuatan. Admin juga dapat menentukan kolom ini di patch course request untuk mentransfer kepemilikan. Dalam konteks lain, nilainya hanya-baca.
creationTime

string (Timestamp format)

Waktu pembuatan kursus. Menentukan kolom ini dalam mask update kursus akan menyebabkan error.

Hanya baca.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Waktu pembaruan terbaru untuk kursus ini. Menentukan kolom ini dalam mask update kursus akan menyebabkan error.

Hanya baca.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
enrollmentCode

string

Kode pendaftaran yang akan digunakan saat bergabung ke kursus ini. Menentukan kolom ini dalam mask update kursus akan menyebabkan error.

Hanya baca.
courseState

enum (CourseState)

Status kursus. Jika tidak ditentukan, status defaultnya adalah PROVISIONED.
teacherGroupEmail

string

Alamat email grup Google yang berisi semua pengajar kursus. Grup ini tidak menerima email dan hanya dapat digunakan untuk izin.

Hanya baca.
courseGroupEmail

string

Alamat email grup Google yang berisi semua anggota kursus. Grup ini tidak menerima email dan hanya dapat digunakan untuk izin.

Hanya baca.
teacherFolder

object (DriveFolder)

Informasi tentang Folder Drive yang dibagikan kepada semua pengajar kursus.

Kolom ini hanya akan ditetapkan untuk pengajar mata pelajaran dan administrator domain.

Hanya baca.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Kumpulan materi yang muncul di halaman "tentang" pada materi ini.

Hanya baca.
guardiansEnabled

boolean

Apakah notifikasi wali diaktifkan atau tidak untuk kursus ini.

Hanya baca.
calendarId

string

ID Kalender untuk kalender yang dapat dilihat semua anggota kursus, tempat Classroom menambahkan acara untuk tugas dan pengumuman dalam kursus.

Kalender untuk kursus dibuat secara asinkron saat kursus disetel ke CourseState.ACTIVE untuk pertama kalinya (pada waktu pembuatan atau saat diupdate ke ACTIVE melalui UI atau API). ID Kalender tidak akan diisi hingga proses pembuatan selesai.

Hanya baca.
gradebookSettings

object (GradebookSettings)

Setelan buku nilai yang menentukan cara menghitung nilai keseluruhan siswa untuk mata pelajaran dan kepada siapa nilai itu akan ditampilkan.

Hanya baca

CourseState

Kemungkinan negara bagian tempat kursus berada.

Enum
COURSE_STATE_UNSPECIFIED Tidak ada status kursus. Tidak ada pesan Kursus yang ditampilkan yang akan menggunakan nilai ini.
ACTIVE Kursus ini aktif.
ARCHIVED Kursus telah diarsipkan. Anda tidak dapat mengubahnya kecuali untuk mengubahnya ke status yang berbeda.
PROVISIONED Kursus telah dibuat, tetapi belum diaktifkan. Dokumen ini dapat diakses oleh pengajar utama dan administrator domain, yang dapat memodifikasi atau mengubahnya ke status ACTIVE atau DECLINED. Kursus hanya dapat diubah ke PROVISIONED jika berada dalam status DECLINED.
DECLINED Kursus sudah dibuat, tetapi ditolak. Link tersebut dapat diakses oleh pemilik kursus dan administrator domain, meskipun tidak akan ditampilkan di UI web. Anda tidak dapat mengubah mata pelajaran kecuali mengubahnya ke status PROVISIONED. Kursus hanya dapat diubah ke DECLINED jika berada dalam status PROVISIONED.
SUSPENDED Kursus telah ditangguhkan. Anda tidak dapat mengubah kursus, dan hanya pengguna yang diidentifikasi oleh ownerId yang dapat melihat kursus. Kursus dapat berstatus ini jika berpotensi melanggar Persyaratan Layanan.

CourseMaterialSet

Satu set materi yang muncul di halaman "Tentang" pada materi ini. Materi ini mungkin termasuk silabus, jadwal, atau informasi latar belakang lainnya yang berkaitan dengan materi secara keseluruhan.

Representasi JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Kolom
title

string

Judul untuk kumpulan ini.
materials[]

object (CourseMaterial)

Materi yang dilampirkan ke kumpulan ini.

CourseMaterial

Materi yang dilampirkan ke kursus sebagai bagian dari kumpulan materi.

Representasi JSON 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
Kolom
Kolom union material. Data Material. material hanya ada berupa salah satu diantara berikut:
driveFile

object (DriveFile)

Lampiran file Google Drive.
youTubeVideo

object (YouTubeVideo)

Lampiran video YouTube.
form

object (Form)

Lampiran Google Formulir.

GradebookSettings

Setelan buku nilai untuk mata pelajaran. Lihat artikel pusat bantuan untuk mengetahui detailnya.

Representasi JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Kolom
calculationType

enum (CalculationType)

Menunjukkan cara penghitungan nilai keseluruhan.
displaySetting

enum (DisplaySetting)

Menunjukkan siapa yang dapat melihat nilai keseluruhan.
gradeCategories[]

object (GradeCategory)

Kategori nilai yang tersedia untuk tugas mata pelajaran dalam kursus ini.

CalculationType

Metode yang mungkin untuk penghitungan nilai keseluruhan.

Enum
CALCULATION_TYPE_UNSPECIFIED Tidak ada metode yang ditentukan. Data ini tidak pernah ditampilkan.
TOTAL_POINTS Nilai keseluruhan adalah jumlah nilai dibagi dengan jumlah poin total, terlepas dari kategori.
WEIGHTED_CATEGORIES Nilai keseluruhan adalah rata-rata tertimbang berdasarkan kategori.

DisplaySetting

Setelan yang mungkin untuk menampilkan nilai keseluruhan.

Enum
DISPLAY_SETTING_UNSPECIFIED Tidak ada setelan yang ditentukan. Data ini tidak pernah ditampilkan.
SHOW_OVERALL_GRADE Menampilkan nilai keseluruhan di profil siswa dan buku nilai kepada pengajar dan siswa.
HIDE_OVERALL_GRADE Tidak menampilkan nilai keseluruhan di profil siswa atau buku nilai.
SHOW_TEACHERS_ONLY Menampilkan nilai keseluruhan kepada pengajar di profil siswa dan buku nilai. Sembunyikan dari siswa di profil siswa mereka.

Metode

checkAddOnCreationEligibility

 Menampilkan apakah pengguna memenuhi syarat untuk membuat lampiran add-on di kursus tertentu.

checkGradingPeriodsSetupEligibility

 Menampilkan apakah pengguna memenuhi syarat untuk memperbarui GradingPeriodSettings di kursus tertentu.

create

 Membuat kursus.

delete

 Menghapus kursus.

get

 Menampilkan kursus.

getGradingPeriodSettings

 Menampilkan setelan periode penilaian dalam kursus.

list

 Menampilkan daftar kursus yang diizinkan untuk dilihat oleh pengguna yang meminta, dibatasi untuk kursus yang cocok dengan permintaan.

patch

 Memperbarui satu atau beberapa kolom dalam kursus.

update

 Memperbarui kursus.

updateGradingPeriodSettings

 Memperbarui setelan periode penilaian kursus.