外掛程式規定

1.0 版,2024 年 4 月 30 日。

本頁所列條件適用於所有 Classroom 外掛程式。外掛程式必須符合所有適用的必要項目,才能獲準發布至 Google Workspace Marketplace,以及「與 Classroom 搭配使用」外掛程式。

本文件中的下列關鍵字:「必須」、「不得」、「必要」、「應」、「不應」、「應該」、「不應該」、「建議」、「可能」和「選用」等關鍵字,以 RFC 2119 中所述的方式解釋。

需求條件

ID 類型
1.0 使用者授權 (如適用)
  1.1 如果使用者沒有授權,「必須」向使用者顯示易於理解的訊息。訊息「必須」清楚說明外掛程式無法使用的原因,並建議使用者可採取的補救措施。 必要
  1.3 這個外掛程式的 Google Workspace 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 使用者「必須」採用外掛程式工作流程完成課程,不得切換至課程工作流程或使用 Classroom 分享按鈕。 必要
  3.4 本地化選項:語言必須根據瀏覽器設定的本機偏好設定 (如有)。 推薦
  3.5 如果外掛程式定義了 maxPoints,則必須同時設定 pointsEarned學生使用已儲存的老師憑證 (建議做法) 或老師在「學生作業回顧」iframe 開啟繳交的作業時。 必要
  3.9 外掛程式必須遵循 WCAG 2.1 級 AA 無障礙規範。外掛程式開發人員會自行回報,應用程式提交時符合這項規定,且外掛程式持續遵守外掛程式的未來異動。 推薦
  3.10 使用者遇到的問題皆「必須」使用者可理解。 必要
  3.11 如果從複製的作業或複製的課程啟動了 studentViewUriteacherViewUristudentWorkViewUri,外掛程式「不得」在 iframe 中顯示錯誤頁面。 必要
  3.12 如果從複製的作業或複製的課程啟動了 studentViewUriteacherViewUristudentWorkViewUri,外掛程式「必須」顯示新的附件供學生完成,而且「不應」在 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。同時也已從「REQUIRED」變更為「建議」。
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 已將 REQUIRED 變更為 RECOMMENDED。
5.3 新增「如果外掛程式從 iframe 中彈出,則必須在 iframe 中預覽任務的預覽畫面。
5.4 新增「如果外掛程式從 iframe 中彈出,應顯示提示學生返回 Classroom。」
8.1 新增「如果裝置不受支援,則「必須」向使用者顯示訊息,告知使用者該裝置屬於不支援的裝置,且在理想情況下,我們支援哪些裝置。」
8.2 學生的行動裝置作業已從「必要」變更為「建議」。
0.1 版 更新日期:2021 年 9 月 22 日
  第 1 版。