REST Resource: courses

Kaynak: Kurs

Classroom'da 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

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

creating a course ise isteğe bağlı olarak, ilgili takma ad oluşturmak için istekte bu tanımlayıcıyı bir 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

Dersin bu bölümü. Örneğin, "Dönem 2". Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve en fazla 2800 karakterden oluşmalı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 en fazla 3600 karakterden oluşmalı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ı hakkında bilgi edineceğiz. Heyecanla bekliyoruz." Ayarlanırsa bu alan geçerli bir UTF-8 dizesi olmalı ve en fazla 30.000 karakterden oluşmalı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 en fazla 650 karakterden oluşmalı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ı gösteren "me" dize 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 bu 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üğe 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üncelleme zamanı. Kurs güncelleme maskesinde bu alanın belirtilmesi hatayla sonuçlanır.

Salt okunur.

Nanosaniye çözünürlüğe 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. Bir değer 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, kurstaki 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 etkinleştirilip etkinleştirilmediği.

Salt okunur.
calendarId

string

Tüm ders üyelerinin görebileceği, Classroom tarafından sınıf çalışmaları için etkinlikler ve sınıftaki duyurular için eklenen takvimin Takvim Kimliği.

Ders ilk kez CourseState.ACTIVE olarak 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 dersteki genel notunun nasıl hesaplanacağını ve kimlere gösterileceğini belirten not defteri ayarları.

Salt okuma

CourseState

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 kullanmayacak.
ACTIVE Ders etkin.
ARCHIVED Ders arşivlendi. Durumunuzu değiştirmek dışında bir değişiklik yapamazsınız.
PROVISIONED Ders oluşturuldu ancak henüz etkinleştirilmedi. Birincil öğretmen ve alan yöneticileri bu ödeve erişebilir. Bu kişiler, ödevde değişiklik yapabilir ya da durumu ACTIVE veya DECLINED olarak değiştirebilir. Bir kurs yalnızca DECLINED durumundaysa PROVISIONED olarak değiştirilebilir.
DECLINED Ders oluşturuldu ancak reddedildi. Bu form, web kullanıcı arayüzünde görüntülenmese de ders sahibi ve alan yöneticileri tarafından erişilebilir. Derste değişiklik yapamazsınız ancak dersin durumunu PROVISIONED olarak değiştirmeniz gerekir. Bir kurs 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ı ihlal etme potansiyeli varsa bu duruma yerleştirilebilir.

CourseMaterialSet

Kursun "Hakkında" sayfasında görünen bir dizi materyal. Bu materyaller ders programını, zaman çizelgesini veya kursun bütünüyle ilgili başka 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 eklenen malzemeler.

CourseMaterial

Materyal setinin parçası olarak kursa eklenen malzeme.

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
material alanı. 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.

GradebookSettings

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)

Kurstaki sınıf çalışmaları için kullanılabilen not kategorileri.

CalculationType

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 puanı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 kullanılabilecek 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 not gösterilir.
HIDE_OVERALL_GRADE Genel not, not defterinde veya öğrenci profilinde gösterilmez.
SHOW_TEACHERS_ONLY Not defterinde ve öğrenci profilinde öğretmenlere verilen 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

 Bir ders oluşturur.

delete

 Dersleri siler.

get

 Bir dersi döndürür.

list

 İstekte bulunan kullanıcının görüntülemesine izin verilen, istekle eşleşenlerle sınırlı derslerin listesini döndürür.

patch

 Dersteki bir veya daha fazla alanı günceller.

update

 Bir dersi günceller.