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

string

Classroom tarafından atanan bu dersin tanımlayıcısı.

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

Bu alanın bir ders güncelleme maskesinde belirtilmesi hataya neden olur.

name

string

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

section

string

Kursun bölümü. Örneğin, "2. Dönem". Bu alan ayarlanırsa 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 Dersine Hoş Geldiniz." Bu alan ayarlanırsa 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 dersleri ve laboratuvar çalışmalarının bir kombinasyonundan öğreneceğiz. Heyecanlanmaya hazır olun." Bu alan ayarlanırsa geçerli bir UTF-8 dizesi olmalı ve 30.000 karakteri aşmamalıdır.

room

string

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

ownerId

string

Ders 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 sabiti

Bu, bir 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 salt okunurdur.

creationTime

string (Timestamp format)

Kursun oluşturulma zamanı. Bu alanın bir ders güncelleme maskesinde belirtilmesi hataya neden olur.

Salt okunur.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman 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 kursun en son güncellendiği zaman. Bu alanın bir ders güncelleme maskesinde belirtilmesi hataya neden olur.

Salt okunur.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman 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 ders güncelleme maskesinde belirtilmesi hataya neden olur.

Salt okunur.

courseState

enum (CourseState)

Kursun durumu. Belirtilmezse 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)

Dersin tüm öğretmenleriyle paylaşılan bir Drive klasörüyle ilgili bilgiler.

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

Salt okunur.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Bu kursun "hakkında" sayfasında görünen materyal grupları.

Salt okunur.

guardiansEnabled

boolean

Bu ders için veli bildirimlerinin etkinleştirilip etkinleştirilmediği.

Salt okunur.

calendarId

string

Tüm kurs üyelerinin görebileceği bir takvimin takvim kimliği. Classroom, kurs çalışmaları ve kurstaki duyurular için bu takvime etkinlikler ekler.

Bir dersin takvimi, ders 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 kimlere gösterileceğini belirten not defteri ayarları.

Salt okunur.

subject

string

İsteğe bağlıdır. Kursun konusu.

learningStandardSettings

object (CourseLearningStandardSettings)

İsteğe bağlıdır.

Derste kullanılabilen öğrenme standartlarıyla ilgili ayarlar. Bir kursa en fazla 20 öğrenme standardı seti kökü atanabilir.

levels

string

İsteğe bağlıdır. Kursun seviyeleri. Örnekler: "9. sınıf", "Ortaokul", "4. - 5.", "K-2", "3000". Bu alan ayarlanırsa geçerli bir UTF-8 dizesi olmalı ve 1.000 karakterden az olmalıdır.

Bu alan yalnızca courses.patch yöntemi kullanılarak temizlenebilir.

CourseState

Bir dersin bulunabileceği olası durumlar.

Sıralamalar
COURSE_STATE_UNSPECIFIED Kurs durumu yok. Döndürülen hiçbir Course mesajı bu değeri kullanmaz.
ACTIVE Kurs etkin.
ARCHIVED Kurs arşivlendi. Farklı bir eyalet seçmek dışında bu bilgiyi değiştiremezsiniz.
PROVISIONED Kurs oluşturuldu ancak henüz etkinleştirilmedi. Birincil öğretmen ve alan yöneticileri tarafından erişilebilir. Bu kullanıcılar, şablonu değiştirebilir veya ACTIVE ya da DECLINED durumlarına geçirebilir. Bir kurs yalnızca DECLINED durumundaysa PROVISIONED olarak değiştirilebilir.
DECLINED Kurs oluşturuldu ancak reddedildi. Kurs sahibi ve alan yöneticileri tarafından erişilebilir ancak web kullanıcı arayüzünde gösterilmez. 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 ile tanımlanan kullanıcı görüntüleyebilir. Hizmet Şartları'nı ihlal etme olasılığı bulunan kurslar bu duruma alınabilir.

CourseMaterialSet

Kursun "Hakkında" sayfasında görünen bir dizi materyal. Bu materyaller arasında ders müfredatı, program veya dersin 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
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Alanlar
Malzeme verileri. Aşağıda, birbirini dışlayan alanların listesi verilmiştir. Yanıtta en fazla bir alan ayarlanır:
driveFile

object (DriveFile)

Google Drive dosya eki.

youTubeVideo

object (YouTubeVideo)

YouTube video eki.

form

object (Form)

Google Formlar eki.

Birbirini hariç tutan alanların sonu.

GradebookSettings

Bir dersin not defteri ayarları. Ayrıntılar 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)

Dersteki çalışma materyalleri için kullanılabilen not kategorileri.

CalculationType

Genel not hesaplaması için kullanılabilecek 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 elde edilir.
WEIGHTED_CATEGORIES Genel not, kategoriye göre ağırlıklı ortalamadır.

DisplaySetting

Genel notu göstermek 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 defterindeki ve öğrenci profilindeki genel notu hem öğretmenlere hem de öğrencilere gösterir.
HIDE_OVERALL_GRADE Not defterinde veya öğrenci profilinde genel notu göstermez.
SHOW_TEACHERS_ONLY Öğretmenlere, not defterinde ve öğrenci profilinde genel notu gösterir. Öğrencilerin öğrenci profilinde gizlenir.

CourseLearningStandardSettings

Bir dersin öğrenme standartları seti ayarları.

JSON gösterimi
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Alanlar
standardSets[]

object (LearningStandardSetRoot)

Zorunlu. Bu derse uygulanan öğrenme standardı kökleri grubu.

LearningStandardSetRoot

Seçilen öğrenme standartları grubunun kökünü temsil eder. Classroom kullanıcı arayüzündeki akış öğelerinde öğrenim hedefleri ayarlanırken seçilen köklerin alt öğeleri gösterilir.

JSON gösterimi
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Alanlar
caseGuid

object (CaseGuid)

Zorunlu. Öğrenme standardı seti kökü için Satchel Rosetta Exchange GUID'si.

documentTitle

string

Yalnızca çıkış. Öğrenme standardı seti kökünün belge başlığı.

standardTitle

string

Yalnızca çıkış. Öğrenme standardı seti kökünün başlığı.

sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Yalnızca çıkış. Öğrenme standardı seti kökünün kullanılabilirlik durumu. Öğrenme standartları seti kökünün kaynaktan silinip silinmediğini belirlemek için bunu kullanın.

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

Bir dersi siler.

get

Bir ders döndürür.

getGradingPeriodSettings

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

list

İstekte bulunan kullanıcının görüntülemesine izin verilen ve istekle eşleşen kursların listesini döndürür.

patch

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

update

Bir kursu günceller.

updateGradingPeriodSettings

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