外掛程式規定

1.0 版,2024 年 4 月 30 日。

本頁中的標準適用於所有 Classroom 外掛程式。您的外掛程式必須符合所有適用項目才能獲准在 Google Workspace Marketplace 中上架,以及支援「與 Classroom」搭配使用的外掛程式。

這份文件中的下列關鍵字:「必須」、「不得」、「必要」、「應」、「不應」、「應」、「不應」、「建議」、「可能」和「選用」等關鍵字如 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 傳送至 Auth 程式庫,以便篩除無效帳戶。
必要
  2.7 次 如果 Classroom 使用者尚未登入外掛程式 (依登入提示判斷),外掛程式「必須」顯示「使用 Google 帳戶登入」按鈕,讓使用者明確採取動作,才會觸發登入程序。
注意:這是符合 Google 品牌宣傳指南的必要步驟,同時有助於避免封鎖彈出式視窗。
必要
  2.8 次 這個外掛程式必須顯示目前已登入的使用者。 推薦
3.0 版 一般
  3.1 外掛程式「必須」遵循一般的 Google Workspace Marketplace 核准指南 必要
  3.2 透過任何 iframe 歷程在新分頁或視窗中啟動的工作時,「必須」提供容易理解的訊息,以便返回 Classroom。 必要
  3.3 使用者「只能」透過外掛程式工作流程完成遷移程序,不得切換至課程作業流程或使用 Classroom 分享按鈕。 必要
  3.4 本地化選項:語言必須採用瀏覽器設定的本機偏好設定 (如果有的話)。 推薦
  3.5 如果外掛程式定義 maxPoints,那麼當學生使用已儲存的老師憑證完成繳交作業時,「必須」一併設定 pointsEarned (建議做法),「或是」在老師在學生作業審查 iframe 中開啟繳交的作業時。 必要
  3.9 外掛程式應符合 WCAG 2.1 等級 AA 的無障礙設計規範。外掛程式開發人員會在提交後自行回報這項規定,且該外掛程式也會持續符合日後的外掛程式異動。 推薦
  3.10 使用者遇到的所有錯誤都必須是人類可讀的格式。 必要
  3.11 如果 studentViewUriteacherViewUristudentWorkViewUri 是透過複製的作業或複製的課程啟動,外掛程式「不得」在 iframe 中顯示錯誤頁面。 必要
  3.12 如果 studentViewUriteacherViewUristudentWorkViewUri 是從複製的作業或複製的課程啟動,外掛程式「不應」在 iframe 中顯示新附件供學生完成,且「不應」在 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 如果活動需要學生執行特定動作才能將作業標示為完成,則該按鈕「不得」標示為「繳交」,以免與「Classroom 繳交」按鈕產生混淆。 必要
6.0 老師檢視畫面
  6.1 老師應該可以看到學生完成作業後會看到的內容。 推薦
7.0 版 學生作業回顧
  7.1 啟動 studentWorkReviewUri 後,這個外掛程式「必須」在 iframe 中顯示學生的作業,供老師批改。補充資料則可在 iframe 外連結。 必要
  7.2 這個外掛程式「不得」在「studentWorkReviewUri」檢視畫面中為學生啟用導覽功能。學生「必須」只能在 Classroom 使用者介面中進行導覽。 必要
8.0 版 Classroom 行動裝置支援
  8.1 當 Classroom 行動應用程式啟動 teacherViewUristudentViewUristudentWorkReviewUri 時,網址「必須」開啟合作夥伴的行動版原生應用程式或合作夥伴的行動網路應用程式,也可以深層連結到正確的檢視畫面。如果裝置不受支援,「必須」向使用者顯示訊息,告知使用者裝置不受支援,且最好說明支援的裝置。 必要
  8.2 學生應該可以在行動裝置上完成作業。 推薦
9.0 其他功能
  9.1 如果老師能以連結附件的形式貼上您的內容連結,就必須升級外掛程式附件的連結 推薦
  9.2 如果您使用 CourseWork 整合功能在 Classroom 外建立作業,就應該為與該外掛程式相容的所有連結預設建立外掛程式附件 推薦

變更記錄

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。此外,已從「必要」變更為「建議」 。
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 新增 studentViewUriteacherViewUristudentWorkReviewUri 的必要課程文案和建議指南。
第 0.2 版 更新日期:2021 年 10 月 29 日
1.3 已調整文字,使其更易於辨識。
3.1 新增「外掛程式必須遵循自家網站上載明的一般 GWM 核准規範。」
3.9 WCAG 已將「必要」變更為「建議」。
5.1 已將「必填」變更為「建議」。
5.3 新增「如果從 iframe 彈出外掛程式,就「必須」能在 iframe 中預覽該工作。」
5.4 新增「如果 iframe 中彈出外掛程式,系統應提示學生返回 Classroom。」
8.1 新增「如果裝置不受支援,必須向使用者顯示訊息,告知使用者裝置屬於不支援的裝置,且理想情況下支援的裝置包括支援的裝置。」
8.2 行動裝置的學生作業已從「必要」變更為「建議」。
0.1 版 更新日期:2021 年 9 月 22 日
  第 1 版。