有興趣的 SIS 合作夥伴可以使用 GitHub 上的相容性測試,判斷自家產品是否符合 Google Classroom 的 OneRoster 使用需求。
存取及執行測試
如要執行測試,您需要:
- 用於擷取 OAuth 2.0 憑證的權杖網址
- 結尾為
/ims/oneroster/v1p1
的 OneRoster 網址 - 用戶端 ID
- 用戶端密碼
- 老師的電子郵件地址
您可以使用 Google Colab 或 Jupyter 筆記本執行測試。Colab 和 Jupyter 筆記本都能讓您一次執行所有測試。這有助於您產生測試結果,以便與 Google Classroom 團隊分享。
SIS 規定和預期行為
Google 定義的測試可讓有興趣的 SIS 合作夥伴判斷自家產品是否符合 Google 的 OneRoster 使用要求,並盡量減少使用者在 Classroom 中使用 SIS 整合功能時可能遇到的錯誤。請詳閱下列測試指標。在 GitHub 中,每個測試都有一個標題,會在指標中參照。請注意,這些指標可協助釐清問題,但並非完整的測試清單。請務必執行 GitHub 提供的所有測試。
測試 | 指標 |
---|---|
老師:GetAllTeachers | 使用 limit 查詢參數呼叫 GET /teachers 端點。在後續測試中,這個參數可確保產品可支援 10,000 個頁面大小。 |
老師:使用電子郵件篩選器執行 GetAllTeachers | 系統會使用 filter 查詢參數呼叫 GET /teachers 端點,用於根據老師的電子郵件地址進行篩選。系統會使用您在測驗的「憑證」部分提供的教師電子郵件地址。 |
類別:GetClassesForTeacher | 呼叫 /teachers/{teacher_sourced_id}/classes 端點時,會使用 filter 查詢參數,用於根據有效類別進行篩選。 |
學生:GetStudentsForClass | 系統會呼叫 GET /classes/{class_sourced_id}/students 端點。回應中必須傳回學生的電子郵件地址。 |
GetGradingPeriodsForTerm | 評分期間支援功能會使用 term_sourced_id 進行測試。這個 term_sourced_id 會呼叫 GET terms/{term_sourced_id}/gradingPeriods 端點,藉此擷取學期中的評分期間。 |
LineItem:Create | 呼叫 PUT /lineItems/{line_item_sourced_id} 時,不需要指定評分期間。 |
LineItem:編輯 | 如果包含長的作業名稱長度,API 呼叫就不會傳回錯誤。測試包含任務名稱,長度超過 100 個字元。 |
結果:編輯 | score 應可設為大於 resultValueMax 的值,以代表額外學分。 |
結果:刪除 | 必須提供 DELETE /results/{result_sourced_id} 端點。 |
LineItem (選用 / 清理):刪除和取得 | 不需要 DELETE /lineItems/{line_item_sourced_id} 端點。這是選用項目,用於資料清理。後續的 GET /classes/{class_sourced_id}/lineItems 端點也是選用項目,可用於測試委刊項是否已刪除。 |
將測試結果提供給 Google Classroom 團隊
執行測試後,系統會產生包含每項測試結果的完整報告。這些測試可用於判斷您的產品是否符合 Google 的 OneRoster 1.1 使用規定。下載產生的報表或擷取螢幕截圖,然後與 Google Classroom 團隊分享。
取得支援
如有任何問題或疑慮,請傳送電子郵件至 classroom-sis-external@google.com。