1.1 版,2024 年 12 月 5 日。
本頁的條件適用於所有 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 自動登入使用者,且後續造訪時不顯示登入提示。 如果登入提示與目前登入的使用者不符,外掛程式「必須」向使用者顯示登入按鈕,並將登入提示傳遞至驗證程式庫,以篩除無效帳戶。 |
必要 | |
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 | 如果活動中顯示標示為「繳交」的按鈕或連結,則「必須」透過 API 要求提交學生的作業,供老師審查。 | 必要 | |
6.0 | 老師檢視畫面 | ||
6.1 | 老師「應該」能看到學生做作業時會看到的內容。 | 推薦 | |
7.0 | 檢閱學生作業 | ||
7.1 | 如果啟動 studentWorkReviewUri ,外掛程式必須在 iframe 中顯示該學生的作業,供老師審查。補充資料可能會連結至 iframe 外部。 |
必要 | |
7.2 | 外掛程式「不得」在 studentWorkReviewUri 檢視畫面中啟用學生之間的導覽功能。學生之間的導覽「只能」在 Classroom 使用者介面中進行。 |
必要 | |
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 | 從「必要」改為「建議」。 |
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 Workspace Marketplace 網站上的一般核准指南。」 |
3.9 | WCAG 將「必要」變更為「建議」。 |
5.1 | 將「必要」改為「建議」。 |
5.3 | 新增「如果外掛程式彈出 iframe,iframe 中『必須』要有工作預覽畫面。」 |
5.4 | 新增「如果外掛程式彈出 iframe,系統『應該』會提示學生返回 Classroom。」 |
8.1 | 新增「如果裝置不支援,系統『必須』向使用者顯示訊息,告知裝置不支援,最好還能說明支援哪些裝置。」 |
8.2 | 行動裝置學生作業從「必要」變更為「建議」。 |
0.1 版 | 更新日期:2021 年 9 月 22 日 |
第 1 版。 |