總覽

Google Classroom API 提供程式設計介面,方便軟體開發人員、管理員和學校主管管理 Google Classroom 資源。您可以建構軟體,用於建立、擷取及修改 Classroom 課程及其內容。

常見的用途包括:

  • 管理課程、學生名單和監護人
  • 新增作業、公告和課程教材
  • 指派成績及修改評分設定
  • 產生可供分析的資料
  • 讓外部供應商提供的內容或工具在 Classroom 中可供探索及存取

Classroom API 是否適合我?

Google 提供多項產品,協助您與 Classroom 互動。以下列舉一些常見情境,並推薦最符合您需求的產品。

修改 Google Classroom 資源

情境 推薦的解決方案
我想定期管理大量課程、使用者或其他 Classroom 資源。我熟悉編寫程式碼和維護軟體基礎架構。 編寫使用 Classroom API 的應用程式。
我想不定期管理少量 Classroom 資源。我可以編寫少量程式碼,且負擔不大。 搭配使用 Classroom API 和 Google Apps Script
我想不時變更個別 Classroom 資源。我熟悉使用終端機指令。 使用 Google Apps Manager
我想要大量報表,其中包含 Classroom 事件的詳細資料。 使用 BigQuery 資料移轉服務
我想調查使用者的活動。 管理控制台中產生報表,或使用 Reports API

與 Google Classroom 整合

情境 推薦的解決方案
我想讓老師和學生在 Classroom 中查看及啟動我的內容。 建構 Classroom 外掛程式
我想讓老師點選網站或應用程式上的按鈕,將我的內容嵌入 Classroom。 建構 Classroom 外掛程式,並以程式輔助方式建立附件
我希望老師按一下網站或應用程式上的按鈕,即可連結至 Classroom 中的內容。 使用 Classroom API 建立課程或嵌入「分享到 Classroom」按鈕。
我想讓 Classroom 老師同步處理或匯入學生資訊系統中的資訊。 實作 OneRoster for SIS,或使用 Classroom API 建立及存取資源。

開始使用

建議新手開發人員在開始新專案前,先完成下列事項:

如要開始開發,請務必完成必要步驟。根據需求選擇適當的 Classroom API 範圍,然後設定環境,並按照其中一項快速入門指南開始提出要求:

嘗試使用 Google APIs Explorer

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

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

您也可以參閱 Classroom API 參考資料