總覽

Classroom API 提供符合 REST 樣式的介面,方便您管理 Google Classroom 中的課程和學生名單。此外,開發人員和內容擁有者可使用 Classroom 分享按鈕,將內容分享到 Classroom。

哪些人可以使用這個 API?

Google Workspace for Education 網域管理員可以使用這個 API,以程式輔助方式代表老師佈建課程、將學生資訊系統與 Classroom 保持同步,並掌握網域中授課課程的基本瀏覽權限。

應用程式開發人員可以使用 Classroom API,整合自己的應用程式與 Classroom。這些應用程式必須使用 OAuth 2.0 才能要求查看老師的課程和學生名單。管理員可限制網域中的老師和學生能否授權應用程式存取自己的 Google Classroom 資料。

網站擁有者和內容開發人員可以使用 Classroom 分享按鈕,讓師生將內容分享回 Classroom。

所有 API 和 Classroom 分享按鈕的整合都應遵循 Classroom 品牌宣傳指南

API 總覽

Classroom API 包含多種實體類型,這些類型分別對應到 Classroom 介面中的課程、老師及學生。除了 Classroom 中原有的屬性,其中部分實體還有 API 專屬的額外屬性。主要實體類型包括:

如要進一步瞭解 API 資源和方法,請參閱 Classroom API 參考資料

課程中繼資料和別名

課程代表類別,例如「M. Smith 的數學概念」,也就是指派老師、學生名單和中繼資料。每個課程都是透過伺服器指派的專屬 ID 來識別。課程資源會特別封裝課程的所有中繼資料,例如名稱、說明、位置和時間。如要管理課程名單,請透過學生老師邀請資源和方法管理。

「別名」是與課程相關聯的類別替代 ID,可用來取代專屬 ID。每個別名都位於命名空間中,限制能建立及查看別名的使用者。支援兩個命名空間:

  • 網域:網域名稱空間適合用來建立所有使用者需要存取,但並非特定程式特有的別名。舉例來說,如果是 MATH 127 和 COMSCI 127 等課程的替代資訊,則應在網域命名空間中建立。網域命名空間中的別名只能由網域管理員建立,但網域中的所有使用者都看得到。
  • 開發人員專案:開發人員專案命名空間有助於管理應用程式專屬的別名。舉例來說,如果應用程式使用課程替代 ID,則可建立別名,將其 ID 對應至 Classroom 課程。在這個命名空間中建立的別名會連結至特定的 Google API 控制台。應用程式的所有使用者都能在其開發人員專案的命名空間中建立及查看別名。

如要進一步瞭解如何管理課程中繼資料和別名,請參閱「管理課程」。

課程學生名單和使用者

「學生」和「老師」是使用者個人資料和課程之間的具體對應項目,代表使用者在課程中的角色。學生和老師的指定不全域:您可以為某門課程指派同一位老師,其他學生則有可能指派給其他學生。指定「學生」或「授課老師」代表特定課程中特定使用者的一組權限。

學生

學生資源代表註冊為學生的使用者

特定的課程學生可以查看該課程的詳細資料和授課老師。

教師

老師資源代表特定課程的教導使用者。

老師可以查看及變更課程詳細資料、查看老師和學生,以及管理其他老師和學生。

邀請及相關方法可讓您輕鬆將學生和老師加入課程。建立邀請可讓使用者選擇是否要加入課程,而不只是直接透過老師和學生資源加入。

UserProfiles 代表了使用者網域個人資料的對應關係,該設定檔由 Directory API 傳回的使用者專屬 ID 或電子郵件地址識別。目前的使用者也可以使用 "me" 簡寫參照自己的 ID。

如要進一步瞭解如何管理學生名單,請參閱「管理老師和學生」。

課程作業和學生繳交的作業

CourseWork 項目代表指派給課程中一組學生的一項工作。其中包含說明、截止日期、資料及建立時間等中繼資料。教材包含標題、縮圖和網址,以及可搭配適當 API (如雲端硬碟、YouTube) 使用的 ID。

CourseWork 項目說明下列其中一種工作類型:

  • 學生提交工作表或其他附件後所完成的作業。
  • 簡答題或選擇題。

CourseWork 項目的學生作業會以「StudentSubmission」的形式呈現。其中包含回應和其他中繼資料,例如狀態和指派的成績。

學生提交的內容取決於對應 CourseWork 項目的類型:

  • 您為作業提交的工作表和附件,包括標題、縮圖和網址,以及可與適當 API (如雲端硬碟或 YouTube) 搭配使用的 ID。
  • 簡答題或選擇題的回覆。

如要進一步瞭解如何管理課程作業和學生繳交的作業,請參閱「管理課堂作業」。

Classroom 外掛程式

外掛程式是合作夥伴提供的 UI,且通常會顯示在 iframe 中。外掛程式會以附件形式顯示在貼文上 (可能是 AnnouncementsCourseWorkCourseWorkMaterials)。

外掛程式附件可以是活動內容

  • 活動附件要求學生完成並繳交個別的提交內容。例如測驗、繪圖或遊戲。您可以選擇為活動提交內容評分。
  • 內容附件並不需要學生繳交。學生無須繳交附件,也不必評分。例如相片、文章和影片

詳情請參閱外掛程式開發指南

快速入門導覽課程

如要設定環境並立即開始使用 API,請參考下列其中一個快速入門導覽課程:

使用 Google APIs Explorer 進行實驗

如要實驗即時資料的呼叫方法,請嘗試使用 Google API Explorer。您不必編寫任何程式碼就能開始使用,但請注意,您使用 API Explorer 的動作可以修改現有的資料。

呼叫該方法的其中一種方法是呼叫 courses.list() 方法。此方法不需要任何要求參數,您可以從傳回的課程清單中擷取 id,做為其他 API 呼叫的要求參數。如果您沒有任何課程,可以使用 courses.create() 方法建立課程。

您也可以探索 API 參考資料