REST Resource: courses

Resource: Course

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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
Kolom
id

string

ID untuk kursus ini yang ditetapkan oleh Classroom.

Saat creating a course, Anda dapat secara opsional 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, "Biologi Kelas 10". Nama wajib diisi. Panjangnya harus antara 1 dan 750 karakter dan berupa 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 boleh lebih dari 2.800 karakter.
descriptionHeading

string

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

string

Deskripsi opsional. Misalnya, "Kita akan mempelajari struktur makhluk hidup dari kombinasi buku teks, kuliah tamu, dan pekerjaan lab. Bersiaplah untuk 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 boleh 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 berikut:

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

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

string (Timestamp format)

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

Hanya baca.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Hanya baca.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
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 default-nya 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 kursus dan administrator domain.

Hanya baca.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

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

Hanya baca.
guardiansEnabled

boolean

Apakah notifikasi wali diaktifkan untuk kursus ini atau tidak.

Hanya baca.
calendarId

string

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

Kalender untuk kursus dibuat secara asinkron saat kursus ditetapkan ke CourseState.ACTIVE untuk pertama kalinya (pada waktu pembuatan atau saat diperbarui 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 penghitungan nilai keseluruhan siswa untuk kursus dan kepada siapa nilai tersebut akan ditampilkan.

Hanya baca.
subject

string

Opsional. Subjek kursus.
learningStandardSettings

object (CourseLearningStandardSettings)

Opsional.

Setelan yang terkait dengan standar pembelajaran yang tersedia di kursus. Satu mata pelajaran dapat memiliki maksimal 20 root set standar pembelajaran yang ditetapkan.
levels

string

Opsional. Level untuk kursus. Contoh: "Kelas 9", "SMP", "Kelas 4 - 5", "TK-SD Kelas 2", "3000". Jika ditetapkan, kolom ini harus berupa string UTF-8 yang valid dan kurang dari 1.000 karakter.

Kolom ini hanya dapat dihapus menggunakan metode courses.patch.

CourseState

Kemungkinan status kursus.

Enum
COURSE_STATE_UNSPECIFIED Tidak ada status kursus. Tidak ada pesan Course yang ditampilkan yang akan menggunakan nilai ini.
ACTIVE Kursus aktif.
ARCHIVED Kursus telah diarsipkan. Anda tidak dapat mengubahnya kecuali untuk mengubahnya ke status yang berbeda.
PROVISIONED Kursus telah dibuat, tetapi belum diaktifkan. Template ini dapat diakses oleh pengajar utama dan administrator domain, yang dapat mengubahnya atau mengubahnya ke status ACTIVE atau DECLINED. Kursus hanya dapat diubah menjadi PROVISIONED jika dalam status DECLINED.
DECLINED Kursus telah dibuat, tetapi ditolak. Kursus ini dapat diakses oleh pemilik kursus dan administrator domain, meskipun tidak akan ditampilkan di UI web. Anda tidak dapat mengubah kursus kecuali untuk mengubahnya ke status PROVISIONED. Kursus hanya dapat diubah menjadi DECLINED jika 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 ditempatkan dalam status ini jika berpotensi melanggar Persyaratan Layanan.

CourseMaterialSet

Serangkaian materi yang muncul di halaman "Tentang" kursus. Materi ini dapat mencakup silabus, jadwal, atau informasi latar belakang lainnya yang terkait dengan kursus secara keseluruhan.

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

string

Judul untuk set ini.
materials[]

object (CourseMaterial)

Materi yang dilampirkan ke set ini.

CourseMaterial

Materi yang dilampirkan ke kursus sebagai bagian dari kumpulan materi.

Representasi JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Kolom
Data material. Berikut adalah daftar kolom yang sama-sama bersifat eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
driveFile

object (DriveFile)

Lampiran file Google Drive.
youTubeVideo

object (YouTubeVideo)

Lampiran video YouTube.
form

object (Form)

Lampiran Google Formulir.
Akhir kolom yang saling eksklusif.

GradebookSettings

Setelan buku nilai untuk kursus. 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.

CalculationType

Kemungkinan metode penghitungan nilai keseluruhan.

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

DisplaySetting

Setelan yang dapat dipilih untuk menampilkan nilai keseluruhan.

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

CourseLearningStandardSettings

Setelan standar pembelajaran untuk kursus.

Representasi JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Kolom
standardSets[]

object (LearningStandardSetRoot)

Wajib. Set root standar pembelajaran yang diterapkan ke kursus ini.

LearningStandardSetRoot

Mewakili root dari kumpulan standar pembelajaran yang dipilih. Turunan dari root yang dipilih akan ditampilkan saat menetapkan sasaran pembelajaran pada item forum di UI Classroom.

Representasi JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Kolom
caseGuid

object (CaseGuid)

Wajib. GUID Satchel Rosetta Exchange untuk root set standar pembelajaran.
documentTitle

string

Hanya output. Judul dokumen root set standar pembelajaran.
standardTitle

string

Hanya output. Judul root set standar pembelajaran.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Hanya output. Status ketersediaan root set standar pembelajaran. Gunakan ini untuk menentukan apakah root set standar pembelajaran telah dihapus dari sumber.

Metode

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 Menampilkan apakah pengguna memenuhi syarat untuk memperbarui GradingPeriodSettings dalam 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, yang dibatasi untuk kursus yang cocok dengan permintaan.

patch

 Memperbarui satu atau beberapa kolom dalam kursus.

update

 Memperbarui kursus.

updateGradingPeriodSettings

 Memperbarui setelan periode penilaian kursus.