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

Bu ders için Classroom tarafından atanan tanımlayıcı.

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

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

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 bir bölümü. Örneğin, "Dönem 2". 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 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ı, konuk dersleri ve laboratuvar çalışmalarını bir arada kullanarak canlı canlıların yapılarını öğreneceğiz. Sizi heyecanla bekliyorum." 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ı.

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 dize değişmez değeri ("me")

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

creationTime

string (Timestamp format)

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

Salt okunur.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Bu kursta yapılan en son güncellemenin zamanı. Bu alanın kurs güncelleme maskesinde belirtilmesi hataya neden olur.

Salt okunur.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Ö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. Bu alanın kurs güncelleme maskesinde belirtilmesi hataya neden olur.

Salt okunur.

courseState

enum (CourseState)

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

teacherGroupEmail

string

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

Salt okunur.

courseGroupEmail

string

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

Salt okunur.

teacherFolder

object (DriveFolder)

Dersteki tüm öğretmenlerle paylaşılan Drive Klasörü hakkındaki bilgiler.

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

Salt okunur.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

"Hakkında" bölümünde görünen malzeme grupları bu kursun devamında bulabilirsiniz.

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'un dersteki sınıf çalışmaları ve duyurularla ilgili etkinlikleri eklediği takvim kimliği.

Bir dersin Takvimi, ders ilk kez CourseState.ACTIVE olarak ayarlandığında (oluşturma zamanında veya kullanıcı arayüzü ya da API aracılığıyla ACTIVE olarak güncellendiğinde) eşzamansız olarak oluşturulur. Oluşturma işlemi tamamlanana kadar Takvim Kimliği 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 okunur

CourseState

Bir kursun yer alabileceği olası durumlar.

Sıralamalar
COURSE_STATE_UNSPECIFIED Ders durumu yok. Döndürülen hiçbir ders mesajı bu değeri kullanmaz.
ACTIVE Kurs etkin.
ARCHIVED Ders arşivlendi. Kodu, farklı bir duruma değiştirmek dışında değişiklik yapamazsınız.
PROVISIONED Ders oluşturuldu ancak henüz etkinleştirilmedi. Birincil öğretmen ve alan yöneticileri tarafından erişilebilir. Bu yöneticiler, söz konusu ayarı değiştirebilir veya ACTIVE ya da DECLINED durumlarıyla değiştirebilir. Bir ders yalnızca DECLINED durumundaysa PROVISIONED olarak değiştirilebilir.
DECLINED Ders oluşturuldu ancak reddedildi. Ders sahibi ve alan yöneticileri bu kursa erişebilir ancak web kullanıcı arayüzünde gösterilmez. Dersi, PROVISIONED durumuna getirmek dışında değiştiremezsiniz. Bir ders yalnızca PROVISIONED durumundaysa DECLINED olarak değiştirilebilir.
SUSPENDED Ders askıya alındı. Dersi değiştiremezsiniz ve yalnızca ownerId tarafından tanımlanan kullanıcı dersi görüntüleyebilir. Hizmet Şartları'nı ihlal etme potansiyeli taşıyan dersler bu duruma eklenebilir.

CourseMaterialSet

"Hakkında" bölümünde görünen bir dizi materyal bu derse bakın. Bu materyaller arasında ders programı, zaman çizelgesi veya kursun bütününe yönelik arka plan bilgileri yer alabilir.

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

string

Bu grubun başlığı.

materials[]

object (CourseMaterial)

Bu gruba ekli materyaller.

CourseMaterial

Bir materyal grubunun parçası olarak kursa eklenen bir 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 ş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

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 gösterir.

gradeCategories[]

object (GradeCategory)

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

CalculationType

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

Sıralamalar
CALCULATION_TYPE_UNSPECIFIED Herhangi bir yöntem belirtilmedi. Bu bilgi hiçbir zaman döndürülmez.
TOTAL_POINTS Genel not, notların toplamının, kategoriye bakılmaksızın toplam puana bölünmesidir.
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 bilgi hiçbir zaman döndürülmez.
SHOW_OVERALL_GRADE Not defterinde ve öğrenci profilinde hem öğretmenlere hem de öğrencilere genel notu gösterir.
HIDE_OVERALL_GRADE Not defterinde veya öğrenci profilinde genel not gösterilmez.
SHOW_TEACHERS_ONLY Not defterinde ve öğrenci profilinde öğretmenlere genel notu gösterir. Öğrenci profillerindeki öğrencilerden gizlenir.

Yöntemler

checkAddOnCreationEligibility

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

checkGradingPeriodsSetupEligibility

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

create

Kurs oluşturur.

delete

Ders silinir.

get

Bir dersi 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 kursların listesini, istekle eşleşen kurslarla sınırlı olacak şekilde döndürür.

patch

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

update

Bir kursu günceller.

updateGradingPeriodSettings

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