REST Resource: courses

Kaynak: Kurs

Classroom'da bir kurs.

JSON gösterimi
{
  "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)
  }
}
Alanlar
id

string

Classroom tarafından bu kursa atanan tanımlayıcı.

creating a course olduğunda, isteğe bağlı olarak bu tanımlayıcıyı, karşılık gelen bir takma ad oluşturma isteğinde alias string olarak ayarlayabilirsiniz. id, Classroom tarafından atanmaya devam eder ve kurs oluşturulduktan sonra güncellenemez.

Bu alanın bir kurs güncelleme maskesinde belirtilmesi hatayla sonuçlanır.

name

string

Kursun adı. Örneğin, "10. Sınıf Biyoloji". Ad gerekli. 1 ile 750 karakter arasında olmalı ve geçerli bir UTF-8 dizesi olmalıdır.

section

string

Kursun bölümü. Örneğin, "2. Dönem". Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve 2.800 karakterden uzun olmamalıdır.

descriptionHeading

string

Açıklama için isteğe bağlı başlık. Örneğin, "10. Sınıf Biyoloji Dersi'ne Hoş Geldiniz." Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve 3.600 karakterden uzun olmamalıdır.

description

string

İsteğe bağlı açıklama. Örneğin, "Canlıların yapısını ders kitapları, konuk öğretim üyelerinin dersleri ve laboratuvar çalışmalarıyla öğreneceğiz. Heyecanlanmaya hazır olun!" Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve 30.000 karakterden uzun olmamalıdır.

room

string

İsteğe bağlı oda konumu. Örneğin, "301". Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve 650 karakterden uzun olmamalıdır.

ownerId

string

Bir kursun sahibinin tanımlayıcısı.

create course request parametresi olarak belirtildiğinde bu alan zorunludur. Tanımlayıcı aşağıdakilerden biri olabilir:

  • Kullanıcının sayısal tanımlayıcısı
  • Kullanıcının e-posta adresi
  • İstekte bulunan kullanıcıyı belirten "me" dize değişmezi

Bu, oluşturma isteğinde ayarlanmalıdır. Yöneticiler, sahipliği aktarmak için bu alanı patch course request içinde de belirtebilir. Diğer bağlamlarda ise salt okunurdur.

creationTime

string (Timestamp format)

Kursun oluşturulma zamanı. Bu alanın bir kurs güncelleme maskesinde belirtilmesi hatayla sonuçlanır.

Salt okunur.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Bu kursta yapılan en son güncellemenin zamanı. Bu alanın bir kurs güncelleme maskesinde belirtilmesi hatayla sonuçlanır.

Salt okunur.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanır. "Z" dışındaki saat farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

enrollmentCode

string

Bu kursa katılırken kullanılacak kayıt kodu. Bu alanın bir kurs güncelleme maskesinde belirtilmesi hatayla sonuçlanır.

Salt okunur.

courseState

enum (CourseState)

Kursun durumu. Belirtilmemişse varsayılan durum PROVISIONED olur.

teacherGroupEmail

string

Kursun tüm öğretmenlerini içeren bir Google grubunun e-posta adresi. Bu grup e-posta kabul etmez ve yalnızca izinler için kullanılabilir.

Salt okunur.

courseGroupEmail

string

Kursun tüm üyelerini içeren bir Google grubunun e-posta adresi. Bu grup e-posta kabul etmez ve yalnızca izinler için kullanılabilir.

Salt okunur.

teacherFolder

object (DriveFolder)

Kursun tüm öğretmenleriyle paylaşılan bir Drive klasörü hakkındaki bilgiler.

Bu alan yalnızca kursun öğretmenleri ve alan yöneticileri için ayarlanır.

Salt okunur.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Bu kursun "Hakkında" sayfasında gösterilen materyal setleri.

Salt okunur.

guardiansEnabled

boolean

Bu kurs için veli bildirimlerinin etkinleştirilip etkinleştirilmediği

Salt okunur.

calendarId

string

Tüm kurs üyelerinin görebileceği, Classroom'un kurs çalışmaları ve duyurular için etkinlik eklediği takvimin takvim kimliği.

Bir kursun takvimi, kurs ilk kez CourseState.ACTIVE olarak ayarlandığında (oluşturma sırasında veya kullanıcı arayüzü ya da API aracılığıyla ACTIVE olarak güncellendiğinde) eşzamansız olarak oluşturulur. Takvim kimliği, oluşturma işlemi tamamlanana kadar doldurulmaz.

Salt okunur.

gradebookSettings

object (GradebookSettings)

Öğrencinin kurstaki genel notunun nasıl hesaplanacağını ve kime gösterileceğini belirten not defteri ayarları.

Salt okunur

CourseState

Kursun olası durumları.

Sıralamalar
COURSE_STATE_UNSPECIFIED Kurs durumu yok. Döndürülen hiçbir Course mesajında bu değer kullanılmaz.
ACTIVE Kurs etkin olmalıdır.
ARCHIVED Kurs arşivlendi. Bu kimliği, farklı bir eyaletle değiştirmek dışında düzenleyemezsiniz.
PROVISIONED Kurs oluşturuldu ancak henüz etkinleştirilmedi. Birincil öğretmen ve alan yöneticileri bu dosyaya erişebilir, dosyayı değiştirebilir veya ACTIVE ya da DECLINED durumuna getirebilir. Bir kurs yalnızca DECLINED durumundaysa PROVISIONED olarak değiştirilebilir.
DECLINED Kurs oluşturuldu ancak reddedildi. Web kullanıcı arayüzünde gösterilmese de kurs sahibi ve alan yöneticileri bu dosyaya erişebilir. Kursu PROVISIONED durumuna getirmek dışında değiştiremezsiniz. Bir kurs yalnızca PROVISIONED durumundaysa DECLINED olarak değiştirilebilir.
SUSPENDED Kurs askıya alındı. Kursu değiştiremezsiniz ve kursu yalnızca ownerId tarafından tanımlanan kullanıcı görüntüleyebilir. Bir kurs, Hizmet Şartları'nı ihlal etme ihtimali varsa bu duruma getirilebilir.

CourseMaterialSet

Kursun "Hakkında" sayfasında gösterilen materyaller. Bu materyaller arasında ders planı, program veya kursun tamamıyla ilgili diğer arka plan bilgileri yer alabilir.

JSON gösterimi
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Alanlar
title

string

Bu grubun başlığı.

materials[]

object (CourseMaterial)

Bu sete eklenen materyaller.

CourseMaterial

Materyal setinin bir parçası olarak kursa eklenen materyal.

JSON gösterimi
{

  // 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.
}
Alanlar
Birleştirme alanı material. Materyal verileri. material yalnızca aşağıdakilerden biri olabilir:
driveFile

object (DriveFile)

Google Drive dosyası eki.

youTubeVideo

object (YouTubeVideo)

YouTube video eki.

form

object (Form)

Google Formlar eki.

GradebookSettings

Bir dersin not defteri ayarları Ayrıntılı bilgi için Yardım Merkezi makalesini inceleyin.

JSON gösterimi
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Alanlar
calculationType

enum (CalculationType)

Genel notun nasıl hesaplandığını gösterir.

displaySetting

enum (DisplaySetting)

Genel notu kimlerin görebileceğini belirtir.

gradeCategories[]

object (GradeCategory)

Kurstaki ödevler için kullanılabilen not kategorileri.

CalculationType

Genel not hesaplaması için olası yöntemler.

Sıralamalar
CALCULATION_TYPE_UNSPECIFIED Yöntem belirtilmedi. Bu değer hiçbir zaman döndürülmez.
TOTAL_POINTS Genel not, kategoriden bağımsız olarak notların toplamının toplam puanların toplamına bölünmesiyle hesaplanır.
WEIGHTED_CATEGORIES Genel not, kategoriye göre ağırlıklı ortalamadır.

DisplaySetting

Genel notu görüntülemek için olası ayarlar.

Sıralamalar
DISPLAY_SETTING_UNSPECIFIED Ayar belirtilmedi. Bu değer hiçbir zaman döndürülmez.
SHOW_OVERALL_GRADE Not defterinde ve öğrenci profilinde genel notu hem öğretmenlere hem de öğrencilere gösterir.
HIDE_OVERALL_GRADE Not defterinde veya öğrenci profilinde genel not gösterilmez.
SHOW_TEACHERS_ONLY Genel notu not defterinde ve öğrenci profilinde öğretmenlere gösterir. Öğrenci profillerinde öğrencilerden gizlenir.

Yöntemler

checkAddOnCreationEligibility
(deprecated)

Kullanıcının belirli bir kursta eklenti ekleri oluşturmaya uygun olup olmadığını döndürür.

checkGradingPeriodsSetupEligibility
(deprecated)

Kullanıcının belirli bir kursta GradingPeriodSettings'i güncellemeye uygun olup olmadığını döndürür.

create

Kurs oluşturur.

delete

Kursu siler.

get

Bir kurs döndürür.

getGradingPeriodSettings

Bir kurstaki notlandırma dönemi ayarlarını döndürür.

list

İstekte bulunan kullanıcının görüntülemesine izin verilen kursların listesini döndürür. Bu liste, yalnızca istekle eşleşen kurslarla sınırlıdır.

patch

Bir kurstaki bir veya daha fazla alanı günceller.

update

Kursu günceller.

updateGradingPeriodSettings

Bir kursun notlandırma dönemi ayarlarını günceller.