軟體開發人員、管理員和學校領導人可透過 Google Classroom API 程式設計介面,管理 Google Classroom 資源。您可以建構軟體,建立、擷取及修改 Classroom 課程和內容。
常見的用途包括:
- 管理課程、學生名單和監護人
- 新增作業、公告和課程教材
- 指派成績及修改評分設定
- 產生用於分析的資料
- 讓外部供應商提供的內容或工具可在 Classroom 中搜尋及存取
Classroom API 是否適合我?
Google 提供多項產品,協助您與 Classroom 互動。以下是一些常見情境,以及最符合您需求的產品建議。
修改 Google Classroom 資源
情境 | 推薦的解決方案 |
---|---|
我想定期管理大量課程、使用者或其他 Classroom 資源。我擅長編寫程式碼及維護軟體基礎架構。 | 編寫使用 Classroom API 的應用程式。 |
我偶爾需要管理少量的 Classroom 資源。我能輕鬆編寫少量程式碼,且負擔低。 | 搭配 Google Apps Script 使用 Classroom API。 |
我想偶爾變更個別 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 Classroom 和 Classroom API 的專屬概念。
- 瞭解 Classroom API 要求的運作方式。
如要開始開發,請確認您已完成必要步驟。根據需求選擇適當的 Classroom API 範圍,然後設定環境,並按照其中一個快速入門導覽課程開始提出要求:
使用 Google APIs Explorer 進行實驗
如要試驗針對即時資料呼叫方法,請使用 Google APIs Explorer。您不必編寫任何程式碼即可開始使用,但請注意,使用 APIs Explorer 執行的動作可能會修改現有資料。
如要開始呼叫方法,可以呼叫 courses.list()
方法。這個方法不需要任何要求參數,您可以從傳回的課程清單中擷取 id
,做為其他 API 呼叫的要求參數。如果沒有任何課程,可以使用 courses.create()
方法建立課程。
您也可以瀏覽 Classroom API 參考資料。