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 trong Google Workspace Marketplace và là 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Ẽ", "KHÔNG SẼ", "NÊN", "KHÔNG NÊN", "NÊN DÙNG", "CÓ THỂ" và "KHÔNG BẮT BUỘC" trong tài liệu này sẽ được diễn giải như mô tả trong RFC 2119.

Yêu cầu

Mã nhận dạng Loại
1.0 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 họ không 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 một phương án hành động để người dùng khắc phục tình huống. 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à bạn có thể phải đáp ứng để sử dụng tiện ích bổ sung. Nếu tiện ích bổ sung có cấp trả 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 một 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,0 Tính năng đăng nhập của 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 tính năng Đăng nhập một lần 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, thì họ PHẢI đăng nhập bằng tính năng Đăng nhập một lần của Google.
BẮT BUỘC
  2.2 Tiện ích bổ sung PHẢI sử dụng tính năng SSO của Google để tự động đăng nhập người dùng trong các lần truy cập tiếp theo mà không hiển thị lời nhắc đăng nhập.
Khi gợi ý đăng nhập không khớp với người dùng hiện đã đă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 login_hint đến 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 chưa đăng nhập vào tiện ích bổ sung (đượ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 nhằm kích hoạt quy 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 PHẢI cho biết người dùng hiện đang đăng nhập là ai. ĐƯỢC ĐỀ XUẤT
3.0 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 chạy trong một thẻ hoặc cửa sổ mới từ bất kỳ hành trình iframe nào, thì nhiệm vụ đó PHẢI cung cấp một thông báo dễ hiểu để người dùng quay lại Lớp học. BẮT BUỘC
  3.3 Người dùng chỉ ĐƯỢC hoàn thành hành trình bằng quy trình làm việc của tiện ích bổ sung và không được chuyển sang quy trình Bài tập trên khoá học hoặc sử dụng Nút chia sẻ trong Lớp học. BẮT BUỘC
  3.4 Lựa chọn bản địa hoá: ngôn ngữ PHẢI dựa trên lựa chọn ưu tiên tại địa phương do trình duyệt đặt ra (nếu có). ĐƯỢC ĐỀ XUẤT
  3,5 Nếu một tiện ích bổ sung xác định maxPoints, thì tiện ích đó CŨNG PHẢI đặt pointsEarned khi học viên hoàn tất việc nộp bài 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 khung hiển thị nội dung nhúng Bài tập của học viên. BẮT BUỘC
  3,9 Tiện ích PHẢI tuân thủ nguyên tắc hỗ trợ tiếp cận theo tiêu chuẩn WCAG 2.1 cấp AA. Nhà phát triển tiện ích bổ sung sẽ tự báo cáo rằng họ đã đáp ứng yêu cầu này tại thời điểm gửi và 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 mà người dùng gặp phải PHẢI là loại lỗi mà con người có thể đọc được. BẮT BUỘC
  3.11 Nếu chạy studentViewUri, teacherViewUri hoặc studentWorkViewUri từ một bài tập đã sao chép hoặc khoá họ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 hoặc khoá học đã sao chép, thì tiện ích bổ sung PHẢI hiển thị một tệp đính kèm mới để học viên hoàn thành và KHÔNG PHẢI 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 một tệp đính kèm yêu cầu học viên gửi, thì 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 những tính 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 từ trang web hoặc các sản phẩm khác
BẮT BUỘC
  4,3 Giáo viên PHẢI có thể tìm thấy và truy cập vào tất cả nội dung/hoạt động mà giáo viên có thể sử dụng. ĐƯỢ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 phải tạo nội dung/hoạt động trước khi có thể đính kèm, thì tác vụ đó PHẢI được hoàn tất trong iframe. ĐƯỢC ĐỀ XUẤT
5 Chế độ xem của học viên
  5.1 Khi studentViewUri chạy, tiện ích bổ sung KHÔNG ĐƯỢC đẩy 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 đẩy 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 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 thực hiện một hành động để đánh dấu bài tập là hoàn tất, thì nút đó KHÔNG ĐƯỢC gắn nhãn là "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 của giáo viên
  6.1 Giáo viên PHẢI xem được nội dung mà học viên sẽ thấy khi làm bài tập. ĐƯỢC ĐỀ XUẤT
7,0 Bài đánh giá bài tập của học viên
  7.1 Nếu studentWorkReviewUri được khởi 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 xem xét 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Ỉ ĐƯỢC 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 Classroom dành cho thiết bị di động khởi chạy teacherViewUri, studentViewUri hoặc studentWorkReviewUri, URL PHẢI mở ứng dụng gốc dành cho thiết bị di động 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, URL đều phải liên kết sâu đến chế độ xem chính xác. Nếu thiết bị không được hỗ trợ, bạn PHẢI hiển thị thông báo cho người dùng để họ biết đó là thiết bị không được hỗ trợ và tốt nhất là những thiết bị nào được hỗ trợ. BẮT BUỘC
  8.2 Học viên PHẢI có thể hoàn thành bài tập 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 PHẢI chuyển các đường liên kết thành tệp đính kèm tiện ích bổ sung. ĐƯỢC ĐỀ XUẤT
  9.2 Nếu sử dụng tính năng tích hợp CourseWork để tạo bài tập từ bên ngoài Lớp học, bạn PHẢI tạo tệp đính kèm tiện ích bổ sung theo mặc định cho tất 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 rằng tiện ích bổ sung không bao giờ chuyển sang trạng thái không thể hiểu 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 thành hai yêu cầu mới.
4,2 Mở rộng nội dung mô tả về những trải nghiệm Khám phá tệp đính kèm được chấp nhận.
4,3 Đã đổi số, trước đây là 4.2. Cũng được thay đổi từ BẮT BUỘC thành NÊN DÙNG.
4,4 Được đánh số lại, trước đây là 4.3.
4,5 Đã đổi số, trước đây là 4.4.
5.2 Đã đổi số, trước đây là 5.3.
5.3 Đã đổi số, trước đây là 5.2.
9.1 Thêm đề xuất nâng cấp các đường liên kết được dán thành tệp đính kèm.
9.2 Thêm đề xuất 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 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 Nội dung chỉnh sửa hướng dẫn gợi ý đăng nhập.
2.4 Tích hợp một tình huống cần triển khai hd.
3.2 Có tên lại là "Provide path" (cung cấp đường dẫn).
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 Thêm hướng dẫn bắt buộc và đề xuất về bản sao khoá học cho studentViewUri, teacherViewUristudentWorkReviewUri.
Phiên bản 0.2 Cập nhật ngày 29 tháng 10 năm 2021
1.3 Điều chỉnh văn bản để rõ ràng hơn về ý định.
3.1 Thêm nội dung "Tiện ích bổ sung PHẢI tuân thủ các nguyên tắc phê duyệt chung của GWM có trên trang web của họ".
3,9 WCAG đã thay đổi từ BẮT BUỘC thành NÊN DÙNG.
5.1 Thay đổi từ BẮT BUỘC thành ĐỀ XUẤT.
5.3 Thêm "Nếu tiện ích bổ sung bật lên khỏi iframe, thì PHẢI có bản xem trước về tác vụ trong iframe."
5.4 Thêm nội dung "Nếu tiện ích bổ sung bật ra khỏi iframe, THÌ sẽ có lời nhắc để học viên quay lại Lớp học".
8.1 Đã thêm thông báo "If the device is supported, a message PHẢI be showing to the user to let they luyện to the an supported device and example, what devices are supported".
8.2 Bài tập của học viên trên thiết bị di động đã thay đổi từ BẮT BUỘC thành NÊN DÙNG.
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.