REST Resource: courses

{
  "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)
  }
}

string

Classroom 指派給這個課程的 ID。

在 creating a course 時，您可以選擇將此 ID 設為要求中的 alias string，以建立對應的別名。id 仍由 Classroom 指派，課程建立後就無法更新。

如果在課程更新遮罩中指定這個欄位，系統會傳回錯誤。

string

課程名稱。例如「10 年級生物」。必須提供名稱。長度必須介於 1 至 750 個半形字元，且必須是有效的 UTF-8 字串。

string

課程的部分。例如「Period 2」。如果已設值，這個欄位必須是有效的 UTF-8 字串，且長度不得超過 2800 個半形字元。

string

說明的選用標題。例如：「Welcome to 10th Grade Biology」。如果已設值，這個欄位必須是有效的 UTF-8 字串，且長度不得超過 3600 個半形字元。

string

選填說明。例如：「我們將透過課本、講師授課和實驗室工作，瞭解生物的結構。敬請期待！設定後，這個欄位必須是有效的 UTF-8 字串，且長度不得超過 30,000 個半形字元。

string

可選的房間位置。例如「301」。如果已設值，這個欄位必須是有效的 UTF-8 字串，且長度不得超過 650 個半形字元。

string

課程擁有者的 ID。

如果指定為 create course request 的參數，則必須填入這個欄位。識別碼可以是下列任一項：

• 使用者的數字 ID
• 使用者的電子郵件地址
• 字串常值 "me"，表示提出要求的使用者

這項屬性必須在建立要求中設定。管理員也可以在 patch course request 中指定這個欄位，以便轉移擁有權。在其他情境中，則為唯讀。

string (Timestamp format)

課程建立時間。如果在課程更新遮罩中指定這個欄位，系統會傳回錯誤。

唯讀。

RFC3339 世界標準時間「Zulu」格式的時間戳記，解析度以奈秒為單位，小數點後最多 9 位。範例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

這個課程最近一次更新的時間。在課程更新遮罩中指定這個欄位會導致錯誤發生。

唯讀。

RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如 "2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string

加入這門課程時使用的註冊代碼。在課程更新遮罩中指定這個欄位會導致錯誤發生。

唯讀。

enum (CourseState)

課程的狀態。如果未指定，則預設狀態為 PROVISIONED。

string

Classroom 網頁版 UI 中，指向這門課程的絕對連結。

唯讀。

string

含有課程所有老師的 Google 群組電子郵件地址。此群組不接受電子郵件地址，並且只能用於權限。

唯讀。

string

包含課程所有成員的 Google 群組電子郵件地址。這個群組不接受電子郵件，只能用於設定權限。

唯讀。

object (DriveFolder)

與課程所有老師共用的雲端硬碟資料夾資訊。

只有課程的老師和網域管理員可設定這個欄位。

唯讀。

object (CourseMaterialSet)

在課程「關於」頁面上顯示的素材資源組合。

唯讀。

boolean

是否為此課程啟用監護人通知。

唯讀。

string

所有課程成員都能查看的 Google 日曆 ID，Classroom 會在該日曆中新增課程作業和公告活動。

當課程首次設為 CourseState.ACTIVE (在建立時或透過 UI 或 API 更新為 ACTIVE 時) 時，系統會以非同步方式建立課程的 Google 日曆。建立程序完成後，系統才會填入日曆 ID。

唯讀。

object (GradebookSettings)

成績單設定，可指定如何計算學生課程的總成績和顯示對象。

唯讀

{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}

string

這個集合的標題。

object (CourseMaterial)

與此套裝方案相關聯的素材。

{

  // 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.
}

object (DriveFile)

Google 雲端硬碟檔案附件。

object (YouTubeVideo)

YouTube 影片附件。

object (Link)

連結附件。

object (Form)

Google 表單附件。

{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}

enum (CalculationType)

指出計算總成績的方式。

enum (DisplaySetting)

指出誰可以查看總成績。

object (GradeCategory)

課程課堂作業可用的成績類別。