Yêu cầu đối với tiện ích bổ sung

Phiên bản 1.0, ngày 30 tháng 4 năm 2024.

Các tiêu chí trên trang này áp dụng cho tất cả tiện ích bổ sung dành cho Lớp học. Tiện ích bổ sung của bạn phải đáp ứng tất cả các mục bắt buộc hiện hành để được phê duyệt đăng thông tin trong Google Workspace Marketplace và một tiện ích bổ sung "Hoạt động với Lớp học".

Các từ khoá "PHẢI", "KHÔNG ĐƯỢC", "BẮT BUỘC", "SỬ DỤNG", "KHÔNG NÊN", "NÊN", "KHÔNG NÊN", "ĐƯỢC ĐỀ XUẤT", "CÓ THỂ" và "KHÔNG BẮT BUỘC" trong tài liệu này phải được hiểu như mô tả trong RFC 2119.

Yêu cầu

Mã nhận dạng Loại
1 Giấy phép của người dùng cuối (nếu có)
  1.1 Một thông báo thân thiện với người dùng PHẢI được hiển thị cho người dùng khi người dùng chưa có giấy phép. Thông báo PHẢI nêu rõ lý do không thể sử dụng tiện ích bổ sung và đề xuất phương án hành động để người dùng khắc phục tình huống này. BẮT BUỘC
  1.3 Trang thông tin của tiện ích bổ sung trên Google Workspace Marketplace PHẢI nêu rõ thông tin chi tiết về các yêu cầu cấp phép mà có thể cần thiết để sử dụng tiện ích bổ sung. Nếu tiện ích bổ sung có bậc có tính phí, thì trang thông tin trên trang web thương mại PHẢI cung cấp đường liên kết đến trang web cung cấp thêm thông tin về giá hoặc cách liên hệ với nhân viên bán hàng. BẮT BUỘC
2 Đăng nhập bằng tài khoản người dùng cuối
  2.1 Người dùng Giáo viên PHẢI đăng nhập vào tiện ích bổ sung bằng dịch vụ SSO của Google.
Nếu người dùng là học viên được yêu cầu đăng nhập vào tiện ích bổ sung, họ PHẢI đăng nhập bằng dịch vụ SSO của Google.
BẮT BUỘC
  2.2 Tiện ích bổ sung PHẢI sử dụng dịch vụ SSO của Google để tự động đăng nhập người dùng vào những lần truy cập tiếp theo mà không cần hiển thị lời nhắc đăng nhập.
Khi gợi ý đăng nhập không cho thấy người dùng đang đăng nhập, tiện ích bổ sung PHẢI nhắc người dùng bằng nút đăng nhập và chuyển sign_hint vào thư viện xác thực để lọc ra các tài khoản không hợp lệ.
BẮT BUỘC
  2.7 Khi người dùng Lớp học chưa đăng nhập vào tiện ích bổ sung (như được xác định bằng cách xem gợi ý đăng nhập), tiện ích bổ sung PHẢI hiển thị nút "Đăng nhập bằng Google" để người dùng thực hiện hành động rõ ràng để kích hoạt quá trình đăng nhập.
Lưu ý: Điều này là cần thiết để đáp ứng nguyên tắc sử dụng thương hiệu của Google và cũng giúp tránh trình chặn cửa sổ bật lên.
BẮT BUỘC
  2.8 Tiện ích bổ sung NÊN hiển thị người dùng hiện đã đăng nhập. ĐƯỢC ĐỀ XUẤT
3 Tổng quan
  3.1 Tiện ích bổ sung PHẢI tuân thủ nguyên tắc phê duyệt chung của Google Workspace Marketplace. BẮT BUỘC
  3.2 Nếu một nhiệm vụ được đưa vào một thẻ hoặc cửa sổ mới từ bất kỳ hành trình nào của iframe, thì nhiệm vụ đó PHẢI đưa ra một thông báo thân thiện với người dùng để quay lại Lớp học. BẮT BUỘC
  3.3 Người dùng chỉ PHẢI hoàn tất quy trình này bằng quy trình công việc bổ sung và không được chuyển sang quy trình làm việc của khoá học hoặc sử dụng Nút chia sẻ Lớp học. BẮT BUỘC
  3.4 Lựa chọn bản địa hoá: ngôn ngữ NÊN dựa trên tùy chọn cục bộ do trình duyệt đặt khi có sẵn. ĐƯỢC ĐỀ XUẤT
  3,5 Nếu một tiện ích bổ sung xác định maxPoints, thì tiện ích bổ sung đó cũng PHẢI đặt pointsEarned khi học viên hoàn thành bài nộp bằng thông tin xác thực của giáo viên đã lưu trữ (nên dùng) HOẶC khi giáo viên mở bài nộp trong iframe Đánh giá bài tập của học viên. BẮT BUỘC
  3,9 Tiện ích bổ sung NÊN tuân thủ nguyên tắc AA cấp WCAG 2.1 về khả năng tiếp cận. Nhà phát triển tiện ích bổ sung sẽ tự báo cáo rằng yêu cầu này được đáp ứng tại thời điểm gửi và rằng tiện ích bổ sung đó tiếp tục tuân thủ các thay đổi trong tương lai đối với tiện ích bổ sung. ĐƯỢC ĐỀ XUẤT
  3,10 Mọi lỗi người dùng gặp phải PHẢI có thể đọc được. BẮT BUỘC
  3,11 Nếu studentViewUri, teacherViewUri hoặc studentWorkViewUri được chạy từ một bài tập đã sao chép hoặc khoá học được sao chép, thì tiện ích bổ sung KHÔNG ĐƯỢC hiển thị trang lỗi trong iframe. BẮT BUỘC
  3,12 Nếu studentViewUri, teacherViewUri hoặc studentWorkViewUri được chạy từ một bài tập đã sao chép hoặc khoá học đã sao chép, thì tiện ích bổ sung NÊN hiển thị tệp đính kèm mới để học viên hoàn tất và KHÔNG ĐƯỢC hiển thị câu trả lời của học viên từ các bài tập hoặc khoá học trước đó trong iframe. ĐƯỢC ĐỀ XUẤT
4,0 Khám phá tệp đính kèm
  4.1 Nếu tệp đính kèm yêu cầu học viên nộp, tệp đính kèm PHẢI bao gồm studentWorkReviewUri để được coi là loại hoạt động chứ không phải tệp đính kèm loại nội dung. BẮT BUỘC
  4,2 iframe Khám phá tệp đính kèm PHẢI cung cấp giao diện người dùng cung cấp ít nhất một trong các chức năng sau:
  • Tạo nội dung mới để đính kèm
  • Duyệt qua, chọn và đính kèm từ thư viện nội dung
  • Hướng dẫn đính kèm nội dung trên trang web hoặc các sản phẩm khác của bạn
BẮT BUỘC
  4,3 Giáo viên PHẢI có thể tìm và truy cập tất cả nội dung/hoạt động dành cho giáo viên. ĐƯỢC ĐỀ XUẤT
  4,4 Giáo viên PHẢI xem trước được nội dung/hoạt động trước khi cam kết đính kèm nội dung/hoạt động đó vào bài tập. BẮT BUỘC
  4,5 Nếu giáo viên cần công việc để tạo nội dung/hoạt động trước khi có thể đính kèm, công việc đó NÊN được hoàn tất trong iframe. ĐƯỢC ĐỀ XUẤT
5 Chế độ xem của học viên
  5.1 Khi studentViewUri được chạy, tiện ích bổ sung KHÔNG ĐƯỢC đưa người dùng ra khỏi iframe để hoàn thành một nhiệm vụ.
Nếu tiện ích bổ sung này đưa người dùng ra khỏi iframe, thì PHẢI có thông báo hoặc chỉ báo khác để học viên quay lại Lớp học.
ĐƯỢC ĐỀ XUẤT
  5.2 Nếu một hoạt động của tiện ích bổ sung bật ra khỏi iframe, PHẢI có bản xem trước về tác vụ đó trong iframe. BẮT BUỘC
  5.3 Nếu một hoạt động yêu cầu học viên làm một việc nào đó để đánh dấu bài tập là đã hoàn thành, thì nút KHÔNG được gắn nhãn "Nộp bài" để tránh nhầm lẫn với nút Nộp bài trong Lớp học. BẮT BUỘC
6,0 Chế độ xem dành cho giáo viên
  6.1 Giáo viên PHẢI có thể thấy nội dung mà học viên sẽ thấy khi họ làm bài tập. ĐƯỢC ĐỀ XUẤT
7 Đánh giá bài tập của học viên
  7.1 Nếu studentWorkReviewUri được chạy, tiện ích bổ sung PHẢI hiển thị bài tập của học viên đó để giáo viên đánh giá trong iframe. Tài liệu bổ sung có thể liên kết bên ngoài iframe. BẮT BUỘC
  7.2 Tiện ích bổ sung KHÔNG ĐƯỢC cho phép điều hướng giữa các học viên trong chế độ xem studentWorkReviewUri. Việc di chuyển giữa các học viên chỉ PHẢI diễn ra trong giao diện người dùng Lớp học. BẮT BUỘC
8,0 Hỗ trợ Lớp học dành cho thiết bị di động
  8.1 Khi ứng dụng Lớp học dành cho thiết bị di động chạy teacherViewUri, studentViewUri hoặc studentWorkReviewUri, URL PHẢI mở ứng dụng gốc dành cho thiết bị di động của đối tác hoặc ứng dụng web dành cho thiết bị di động của đối tác và trong cả hai trường hợp, hãy liên kết sâu đến đúng chế độ xem. Nếu thiết bị không được hỗ trợ, thông báo PHẢI hiển thị với người dùng để cho họ biết đó là thiết bị không được hỗ trợ và lý tưởng nhất là những thiết bị được hỗ trợ. BẮT BUỘC
  8.2 Bài tập của học viên NÊN được hoàn thành trên thiết bị di động. ĐƯỢC ĐỀ XUẤT
9,0 Các tính năng bổ sung
  9.1 Nếu giáo viên có thể dán đường liên kết đến nội dung của bạn dưới dạng tệp đính kèm Đường liên kết, thì bạn NÊN nâng cấp đường liên kết lên tệp đính kèm của tiện ích bổ sung. ĐƯỢC ĐỀ XUẤT
  9.2 Nếu sử dụng tiện ích tích hợp của CourseWork để tạo bài tập từ bên ngoài Lớp học, bạn NÊN tạo tệp đính kèm bằng tiện ích bổ sung theo mặc định cho tất cả các đường liên kết tương thích với tiện ích bổ sung của bạn. ĐƯỢC ĐỀ XUẤT

Nhật ký thay đổi

Phiên bản 1.0 Cập nhật ngày 30 tháng 4 năm 2024
1.1 Kết hợp 1.1 và 1.2 thành một yêu cầu duy nhất.
2.1 Kết hợp 2.1 và 2.5 thành một yêu cầu duy nhất.
2.2 Kết hợp 2.2, 2.3 và 2.4 thành một yêu cầu duy nhất.
3,5 Kết hợp 3,5, 3,6 và 3,7 thành một yêu cầu duy nhất.
3,10 Thêm yêu cầu về việc tiện ích bổ sung không bao giờ chuyển sang trạng thái không rõ hoặc không thể khôi phục.
3.11, 3.12 Kết hợp 5.5, 5.6, 6.3, 6.4, 7.5 và 7.6 vào 2 yêu cầu mới.
4,2 Mở rộng nội dung mô tả về trải nghiệm Khám phá tệp đính kèm được chấp nhận.
4,3 Được đánh số lại, trước đây là 4.2. Đồng thời cũng được thay đổi từ REQUIRED thành REQUIRED.
4,4 Được đánh số lại, trước đây là 4.3.
4,5 Được đánh số lại, trước đây là 4.4.
5.2 Được đánh số lại, trước đây là 5.3.
5.3 Được đánh số lại, trước đây là 5.2.
9.1 Đã thêm đề xuất nâng cấp đường liên kết đã dán vào tệp đính kèm.
9.2 Thêm yêu cầu để tạo tệp đính kèm bằng tiện ích bổ sung theo mặc định khi tạo bài tập trong CourseWork theo phương thức lập trình.
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 Đã xoá.
Phiên bản 0.3 Cập nhật ngày 22 tháng 11 năm 2022
2.3 Sửa hướng dẫn gợi ý đăng nhập.
2.4 Tích hợp một trường hợp bắt buộc phải triển khai hd.
3.2 Được đổi tên thành "cung cấp đường dẫn".
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Thêm nội dung khoá học cần thiết và hướng dẫn đề xuất cho studentViewUri, teacherViewUristudentWorkReviewUri.
Phiên bản 0.2 Cập nhật vào ngày 29 tháng 10 năm 2021
1.3 Chỉnh sửa văn bản để thể hiện ý định rõ ràng hơn.
3.1 Thêm "Tiện ích bổ sung PHẢI tuân thủ các nguyên tắc phê duyệt chung của GWM được tìm thấy trên trang web của họ."
3,9 WCAG đã thay đổi từ REQUIRED thành khoáng (ĐƯỢC ĐỀ XUẤT).
5.1 Đã thay đổi REQUIRED thành REQUIRED.
5.3 Thêm tuỳ chọn "Nếu tiện ích bổ sung bật ra khỏi iframe, thì PHẢI có bản xem trước về tác vụ trong iframe."
5,4 Thêm "Nếu tiện ích bật ra khỏi iframe, có nên có một lời nhắc dành cho sinh viên để quay lại Lớp học."
8.1 Thêm giá trị "If the device is supported, a notification PHẢI be Display to the user to for their why that's an supported device and instead of these devices are supported."
8.2 Đã thay đổi bài tập của học viên trên thiết bị di động từ REQUIRED thành REQUIRED.
Phiên bản 0.1 Cập nhật ngày 22 tháng 9 năm 2021
  Bản phát hành đầu tiên.