2024 年 4 月 30 日，1.0 版。
本頁的條件適用於所有 Classroom 外掛程式。外掛程式必須符合所有適用的必要項目，才能獲得核准，並在 Google Workspace Marketplace 中列出「可與 Classroom 搭配使用」的外掛程式。
本文件中的關鍵字「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」和「OPTIONAL」應按照 RFC 2119 的說明進行解讀。
需求條件
| ID | 類型 | ||
|---|---|---|---|
| 1.0 | 使用者授權 (如適用) | ||
| 1.1 | 當使用者沒有授權時，系統應向使用者顯示友善的訊息。訊息應清楚說明無法使用外掛程式的理由，並建議使用者採取哪些行動來解決問題。 | 推薦 | |
| 1.3 | 外掛程式的 Google Workspace Marketplace 產品資訊應詳細說明使用外掛程式可能需要的授權和訂閱要求。如果外掛程式有付費方案，Marketplace 產品資訊應提供網頁連結，讓使用者進一步瞭解價格或聯絡業務人員的方式。 | 推薦 | |
| 2.0 | 使用者登入 | ||
| 2.1 | 老師使用者必須使用 Google 單一登入 (SSO) 服務登入外掛程式。 如果系統要求學生使用者登入外掛程式，他們必須使用 Google 單一登入 (SSO) 服務登入。 |
必要 | |
| 2.2 | 外掛程式必須使用 Google SSO，在使用者後續造訪時自動登入，且不顯示登入提示。 如果登入提示與目前登入的使用者不符，外掛程式必須顯示登入按鈕，並將 login_hint 傳遞至驗證程式庫，篩除無效帳戶。 |
必要 | |
| 2.7 | 如果 Classroom 使用者尚未登入外掛程式 (根據登入提示判斷)，外掛程式必須顯示「使用 Google 帳戶登入」按鈕，讓使用者明確採取動作，觸發登入程序。 注意：這項做法有助於符合 Google 品牌指南，並避免使用者安裝彈出式視窗封鎖程式。 |
必要 | |
| 2.8 次 | 外掛程式應顯示目前登入的使用者為何人。 | 推薦 | |
| 3.0 | 一般 | ||
| 3.1 | 外掛程式必須遵守一般 Google Workspace Marketplace 核准規範。 | 必要 | |
| 3.2 | 如果透過任何 iframe 歷程啟動工作至新分頁或視窗，應提供友善的訊息，讓使用者返回 Classroom。 | 推薦 | |
| 3.3 | 使用者必須只使用外掛程式工作流程完成歷程，不得切換至 courseWork 工作流程或使用 Classroom 分享按鈕。 | 必要 | |
| 3.4 | 本地化選項：語言應根據瀏覽器設定的本地偏好設定 (如有)。 | 推薦 | |
| 3.5 | 如果外掛程式定義了 maxPoints，則在學生使用儲存的授課者憑證完成提交作業 (建議) 或老師在學生作業審查 iframe 中開啟提交作業時，外掛程式也必須設定 pointsEarned。 |
必要 | |
| 3.9 | 外掛程式應符合無障礙設計的 WCAG 2.1 AA 級指南。外掛程式開發人員會在提交時自行回報已符合這項規定，並保證日後的修訂版本也會持續符合規定。 | 推薦 | |
| 3.10 | 使用者遇到的任何錯誤都應可供人類閱讀。 | 推薦 | |
| 3.11 | 如果 studentViewUri、teacherViewUri 或 studentWorkViewUri 是從複製的作業或課程啟動，則外掛程式不得在 iframe 中顯示錯誤頁面。 |
必要 | |
| 4.0 | 附件探索 | ||
| 4.1 | 如果附件需要學生提交內容，則該附件必須包含 studentWorkReviewUri，系統才能將其視為活動類型，而非內容類型附件。 |
必要 | |
| 4.2 | 附件探索 iframe 必須提供至少下列其中一項的使用者介面：
|
必要 | |
| 4.3 | 老師應能找到並存取所有可用的內容/活動。 | 推薦 | |
| 4.4 | 老師應先預覽內容/活動，再決定是否要將其附加到作業。 | 推薦 | |
| 4.5 | 如果教師需要先建立內容/活動，才能附加到課程中，則應在 iframe 中完成該工作。 | 推薦 | |
| 5.0 | 學生檢視畫面 | ||
| 5.1 | 啟動 studentViewUri 時，外掛程式不應彈出使用者離開 iframe，以便完成工作。如果外掛程式確實彈出使用者離開 iframe，則必須顯示訊息或其他指示，讓學生返回 Classroom。 |
推薦 | |
| 5.2 | 如果外掛程式活動彈出 iframe，iframe 中應會顯示工作預覽畫面。 | 推薦 | |
| 5.3 | 如果有，活動中標示為「Turn in」的按鈕或連結必須觸發 API 要求，將學生的作業提交給老師審查。 | 必要 | |
| 6.0 | 教師檢視畫面 | ||
| 6.1 | 老師應能看到學生在做作業時看到的內容。 | 推薦 | |
| 7.0 | 學生作品評估 | ||
| 7.1 | 如果啟動 studentWorkReviewUri，外掛程式必須在 iframe 中呈現學生的作業，供老師查看。補充資料可以連結至 iframe 外部。 |
必要 | |
| 7.2 | 外掛程式不得在 studentWorkReviewUri 檢視畫面中啟用學生間的導覽功能。學生之間的導覽作業必須在 Classroom UI 中進行。 |
必要 | |
| 8.0 | Classroom 行動版支援服務 | ||
| 8.1 | 當 Classroom 行動應用程式啟動 teacherViewUri、studentViewUri 或 studentWorkReviewUri 時，網址必須開啟合作夥伴的行動原生應用程式或合作夥伴的行動網頁應用程式，並在任何情況下深層連結至正確的檢視畫面。如果裝置不受支援，系統必須向使用者顯示訊息，告知他們裝置不受支援，並最好指出哪些裝置受支援。 |
必要 | |
| 8.2 | 學生應可在行動裝置上完成作業。 | 推薦 | |
| 9.0 | 其他功能 | ||
| 9.1 | 如果老師可以將連結貼到您的內容中，並做為連結附件，您就應將連結升級為外掛程式附件。 | 推薦 | |
| 9.2 | 如果您使用 CourseWork 整合功能，透過 Classroom 以外的管道建立作業，則應預設為所有與外掛程式相容的連結建立外掛程式附件。 | 推薦 | |
變更記錄
| 1.1 版本 | 更新日期：2024 年 12 月 5 日 |
| 1.1、1.3、3.2、3.10、4.4、5.2 | 已從「REQUIRED」變更為「RECOMMENDED」。 |
| 3.12 | 已移除。 |
| 5.3 | 重新措辭。近期的異動可讓外掛程式開發人員使用 API 可靠地提交學生提交內容。 |
| 1.0 版本 | 更新日期：2024 年 4 月 30 日 |
| 1.1 | 將 1.1 和 1.2 合併為單一規定。 |
| 2.1 | 將 2.1 和 2.5 合併為單一規定。 |
| 2.2 | 將 2.2、2.3 和 2.4 合併為單一規定。 |
| 3.5 | 將 3.5、3.6 和 3.7 合併為單一規定。 |
| 3.10 | 新增要求，外掛程式不得進入無法解讀或無法復原的狀態。 |
| 3.11、3.12 | 將 5.5、5.6、6.3、6.4、7.5 和 7.6 合併為兩項新規定。 |
| 4.2 | 擴充可接受的附件探索體驗說明。 |
| 4.3 | 重新編號，原為 4.2。也從「REQUIRED」變更為「RECOMMENDED」。 |
| 4.4 | 已重新編號，原為 4.3。 |
| 4.5 | 已重新編號，原為 4.4。 |
| 5.2 | 重新編號，原為 5.3。 |
| 5.3 | 重新編號，原為 5.2。 |
| 9.1 | 新增建議，將貼上的連結升級為附件。 |
| 9.2 | 新增建議，在以程式輔助方式建立 CourseWork 作業時，預設會建立外掛程式附件。 |
| 2.6、3.7、3.8、6.2、7.3、7.4 | 已移除。 |
| 0.3 版 | 更新日期：2022 年 11 月 22 日 |
| 2.3 | 修正登入提示指南。 |
| 2.4 | 納入需要實作 hd 的情況。 |
| 3.2 | 重新修訂「提供路徑」的用詞。 |
| 5.5、5.6、6.3、6.4、7.5、7.6 | 新增 studentViewUri、teacherViewUri 和 studentWorkReviewUri 的課程文案必要和建議指南。 |
| 第 0.2 版 | 更新日期：2021 年 10 月 29 日 |
| 1.3 | 調整文字，讓意圖更明確。 |
| 3.1 | 新增「外掛程式必須遵守 Google 網站上提供的一般 GWM 核准指南。」 |
| 3.9 | WCAG 已將「REQUIRED」變更為「RECOMMENDED」。 |
| 5.1 | 已將「REQUIRED」變更為「RECOMMENDED」。 |
| 5.3 | 新增「如果外掛程式彈出 iframe，則 iframe 中必須有工作預覽畫面。」 |
| 5.4 | 新增「如果外掛程式彈出 iframe，應會提示學生返回 Classroom。」 |
| 8.1 | 新增「如果裝置不受支援，系統必須向使用者顯示訊息，讓他們知道這是不受支援的裝置，並最好指出哪些裝置受支援。」 |
| 8.2 | 學生行動作業的規定已從「必填」變更為「建議」。 |
| 0.1 版 | 更新日期：2021 年 9 月 22 日 |
| 第 1 版。 |