REST Resource: courses

Kaynak: Kurs

Classroom'daki bir ders.

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

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

creating a course kullanırken isteğe bağlı olarak, ilgili takma ad oluşturmak için istekte bu tanımlayıcıyı alias string olarak ayarlayabilirsiniz. id hâlâ Classroom tarafından atanmış durumda ve ders oluşturulduktan sonra güncellenemez.

Kurs güncelleme maskesinde bu alanın belirtilmesi hatayla sonuçlanır.

name

string

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

section

string

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

descriptionHeading

string

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

description

string

İsteğe bağlı açıklama. Örneğin, "Ders kitaplarından, misafir derslerinden ve laboratuvar çalışmalarının bir kombinasyonundan yaşayan canlıların yapısını öğreneceğiz. Heyecanla bekleriz." 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

Ders sahibinin tanımlayıcısı.

Bir 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
  • istekte bulunan kullanıcıyı belirten "me" dize değişmez değeri

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 durumlarda ise salt okunurdur.

creationTime

string (Timestamp format)

Kursun oluşturulma zamanı. Kurs güncelleme maskesinde bu alanın belirtilmesi hatayla sonuçlanır.

Salt okunur.

Nanosaniye çözünürlüğüne ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Bu kursla ilgili en son güncellemenin zamanı. Kurs güncelleme maskesinde bu alanın belirtilmesi hatayla sonuçlanır.

Salt okunur.

Nanosaniye çözünürlüğüne ve en fazla dokuz kesir basamağına sahip, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

enrollmentCode

string

Bu derse katılırken kullanılacak kayıt kodu. Kurs güncelleme maskesinde bu alanın belirtilmesi hatayla sonuçlanır.

Salt okunur.

courseState

enum (CourseState)

Kursun durumu. Belirtilmezse varsayılan durum PROVISIONED olur.

teacherGroupEmail

string

Dersin tüm öğretmenlerini içeren bir Google grubunun e-posta adresi. Bu grup e-posta kabul etmiyor ve yalnızca izin almak 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 etmiyor ve yalnızca izin almak için kullanılabilir.

Salt okunur.

teacherFolder

object (DriveFolder)

Bir Drive klasörü hakkında, dersteki tüm öğretmenlerle paylaşılan bilgiler.

Bu alan yalnızca dersin öğretmenleri ve alan yöneticileri için ayarlanacaktı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 etkin olup olmadığı.

Salt okunur.

calendarId

string

Tüm ders üyelerinin görebileceği bir takvimin Takvim kimliği. Classroom, sınıf çalışmaları için etkinlikleri ve dersteki duyuruları bu takvime ekler.

Kurs ilk kez CourseState.ACTIVE seçeneğine ayarlandığında (oluşturma zamanında veya kullanıcı arayüzü ya da API üzerinden ACTIVE olarak güncellendiğinde) kurs takvimi eşzamansız olarak oluşturulur. Takvim kimliği, oluşturma işlemi tamamlanana kadar doldurulmaz.

Salt okunur.

gradebookSettings

object (GradebookSettings)

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

Salt okuma

Kurs Durumu

Bir kursun içinde bulunabileceği olası durumlar.

Sıralamalar
COURSE_STATE_UNSPECIFIED Kurs durumu yok. Döndürülen Kurs mesajlarının hiçbiri bu değeri kullanmaz.
ACTIVE Kurs etkin.
ARCHIVED Ders arşivlendi. Durumunuzu değiştirmek dışında hiçbir değişiklik yapamazsınız.
PROVISIONED Ders oluşturuldu ancak henüz etkinleştirilmedi. Birincil öğretmen ve alan yöneticileri bu dosyaya erişebilir. Bu yöneticiler, dosyayı değiştirebilir veya ACTIVE ya da DECLINED durumuna geçirebilir. Bir ders yalnızca DECLINED durumundaysa PROVISIONED olarak değiştirilebilir.
DECLINED Ders oluşturuldu ancak reddedildi. Ders sahibi ve alan yöneticileri tarafından erişilebilir ancak web kullanıcı arayüzünde görüntülenmez. PROVISIONED durumunu değiştirmek dışında kursu değiştiremezsiniz. Bir ders yalnızca PROVISIONED durumundaysa DECLINED olarak değiştirilebilir.
SUSPENDED Ders askıya alındı. Derste değişiklik yapamazsınız ve yalnızca ownerId tarafından tanımlanan kullanıcı dersi görüntüleyebilir. Kurs, Hizmet Şartları'nı potansiyel olarak ihlal etmesi durumunda bu duruma yerleştirilebilir.

DersMateryal Seti

Kursun "Hakkında" sayfasında görünen materyaller. Bu materyaller ders programını, zaman çizelgesini veya kursla ilgili diğer arka plan bilgilerini içerebilir.

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

string

Bu grubun başlığı.

materials[]

object (CourseMaterial)

Bu sete ekli materyaller.

Kurs Malzemesi

Materyal setinin parçası olarak kursa eklenen materyaller.

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
Birlik alanı material. Materyal verileri. material şunlardan yalnızca biri olabilir:
driveFile

object (DriveFile)

Google Drive dosya eki.

youTubeVideo

object (YouTubeVideo)

YouTube videosu eki.

form

object (Form)

Google Formlar eki.

Not Defteri Ayarları

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)

Kursta kullanılabilen not kategorileri.

HesaplamaTürü

Genel not hesaplamasında kullanılabilecek olası yöntemler.

Sıralamalar
CALCULATION_TYPE_UNSPECIFIED Yöntem belirtilmedi. Bu değer asla döndürülmez.
TOTAL_POINTS Genel not, notların toplamının, kategoriden bağımsız olarak toplam puana bölünmesiyle elde edilir.
WEIGHTED_CATEGORIES Genel not, kategoriye göre ağırlıklı ortalamadır.

Ekran Ayarı

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

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

Yöntemler

checkAddOnCreationEligibility

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

create

Ders oluşturur.

delete

Dersi siler.

get

Kurs döndürür.

list

İstekte bulunan kullanıcının görüntüleme iznine sahip olduğu kursların listesini (istekle eşleşenlerle sınırlı olacak şekilde) döndürür.

patch

Dersteki bir veya daha fazla alanı günceller.

update

Bir kursu günceller.