使用者是否透過 Google Meet 使用 Classroom？請參閱 Apps Script 快速入門導覽課程，瞭解如何在 Google Meet 課程中查看學生的出席情況。

REST Resource: courses

資源：課程

Classroom 課程。

JSON 表示法 
{
  "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)
  }
}
欄位
id

string

由 Classroom 指派的本課程 ID。

如為 creating a course，您可以選擇在要求中將這個 ID 設為 alias string，以建立相應的別名。Classroom 仍會指派 id，而且課程建立後就無法更新。

在課程更新遮罩中指定這個欄位會發生錯誤。
name

string

課程名稱。例如「10 年級生物學」。必須輸入名稱。長度必須介於 1 至 750 個字元之間，以及有效的 UTF-8 字串。
section

string

課程的章節。例如「期限 2」。設定後，這個欄位必須是有效的 UTF-8 字串，且不得超過 2800 個字元。
descriptionHeading

string

說明的選填標題。例如「歡迎使用 10 年級生物學」。 設定後，這個欄位必須是有效的 UTF-8 字串，且不得超過 3600 個字元。
description

string

(選填) 說明。舉例來說，我們會從教科書、訪客講座和實驗室作業等層面，瞭解生物生物的結構。充滿期待！」 設定之後，這個欄位必須是有效的 UTF-8 字串，且不得超過 30,000 個字元。
room

string

(選用) 聊天室位置。例如「301」。設定後，這個欄位必須是有效的 UTF-8 字串，且長度不得超過 650 個字元。
ownerId

string

課程擁有者的 ID。

指定 create course request 參數時，這是必填欄位。ID 可以是下列任一值：

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

這必須在建立要求中設定。管理員也可以在 patch course request 中指定這個欄位，以便轉移擁有權。在其他情況下，這個值會處於唯讀狀態，
creationTime

string (Timestamp format)

課程的建立時間。在課程更新遮罩中指定這個欄位會發生錯誤。

此為唯讀屬性。

RFC3339 世界標準時間「Zulu」格式的時間戳記，具有奈秒解析度和最多 9 個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

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

此為唯讀屬性。

RFC3339 世界標準時間「Zulu」格式的時間戳記，具有奈秒解析度和最多 9 個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
enrollmentCode

string

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

此為唯讀屬性。
courseState

enum (CourseState)

課程狀態。如果未指定，則預設狀態：PROVISIONED。
teacherGroupEmail

string

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

此為唯讀屬性。
courseGroupEmail

string

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

此為唯讀屬性。
teacherFolder

object (DriveFolder)

雲端硬碟資料夾資訊，會與課程中的所有老師分享。

系統只會為課程的老師和網域管理員設定這個欄位。

此為唯讀屬性。
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

顯示在本課程「關於」頁面上的一組教材。

此為唯讀屬性。
guardiansEnabled

boolean

課程是否需要啟用監護人通知。

此為唯讀屬性。
calendarId

string

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

此為唯讀屬性。
gradebookSettings

object (GradebookSettings)

成績單設定，用於指定學生計算課程總成績的方式，以及要向使用者顯示的對象。

唯讀

課程狀態

可登記的課程狀態。

列舉
COURSE_STATE_UNSPECIFIED 沒有任何課程狀態。系統不會發還任何課程訊息。
ACTIVE 課程正在進行中。
ARCHIVED 這門課程已封存。您無法修改這個狀態，除非將狀態變更為其他狀態。
PROVISIONED 已建立課程，但尚未啟用。主要任課老師和網域管理員都可以存取此文件，也可以將其變更為 ACTIVE 或 DECLINED 狀態。課程必須處於DECLINED狀態，才能變更為 PROVISIONED。
DECLINED 已建立課程，但遭到拒絕。課程擁有者和網域管理員都可以存取這個功能，但網頁介面不會顯示這項資訊。您無法修改課程，除非將課程變更為 PROVISIONED 狀態。課程必須處於PROVISIONED狀態，才能變更為 DECLINED。
SUSPENDED 這個課程已遭停權。您無法修改課程，而且只有 ownerId 識別的使用者可以查看課程。如果課程可能違反《服務條款》，就可能屬於這個狀態。

課程教材集

課程教材的「關於」頁面上會顯示一組教材。這些資料可能包含課程大綱、時間表或其他與課程相關的背景資訊。

JSON 表示法 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
欄位
title

string

這組組合的標題。
materials[]

object (CourseMaterial)

已附加至這組素材的教材。

課程教材

附加至教材的某個教材。

JSON 表示法 
{

  // 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.
}
欄位
聯集欄位 material。教材資料。material 只能是下列其中一項：
driveFile

object (DriveFile)

Google 雲端硬碟檔案附件。
youTubeVideo

object (YouTubeVideo)

YouTube 影片附件。
form

object (Form)

Google 表單附件。

成績單設定

課程的成績單設定。詳情請參閱說明中心文章。

JSON 表示法 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
欄位
calculationType

enum (CalculationType)

表示整體成績的計算方式。
displaySetting

enum (DisplaySetting)

指出誰可以查看總成績。
gradeCategories[]

object (GradeCategory)

課程中可供批改的課程作業。

計算類型

總成績計算方式的可能方法。

列舉
CALCULATION_TYPE_UNSPECIFIED 未指定任何方法。且絕對不會傳回。
TOTAL_POINTS 總成績是指成績總數除以類別總分的總和。
WEIGHTED_CATEGORIES 總成績是指依類別加權的加權平均值。

顯示設定

顯示總成績的可能性設定。

列舉
DISPLAY_SETTING_UNSPECIFIED 未指定設定。且絕對不會傳回。
SHOW_OVERALL_GRADE 顯示成績和學生個人資料中的總成績，以及老師和學生
HIDE_OVERALL_GRADE 不會顯示成績單或學生個人資料中的總成績。
SHOW_TEACHERS_ONLY 顯示成績單和學生設定檔中老師的總成績。在學生的個人資料中向學生隱藏。

方法

create

 建立課程。

delete

 刪除課程。

get

 傳回課程。

list

 傳回提出要求的使用者可檢視的課程清單 (僅限符合要求的課程)。

patch

 更新課程中的一或多個欄位。

update

 更新課程。