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 lên 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ÁNG", "KHÔNG ĐƯỢC", "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 Giấy phép 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 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 hướng 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ó bậc có tính phí, trang thông tin trên Marketplace 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,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 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, thì 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 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 cho thấy thông tin trùng khớp với người dùng hiện đ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 đế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 Lớp học chưa đăng nhập vào tiện ích bổ sung (như 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 thao tác 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 các nguyên tắc sử dụng thương hiệu của Google, đồng thời giúp tránh các 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 đang đăng nhập là ai. ĐỀ 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 tác vụ được chạy trong thẻ hoặc cửa sổ mới từ bất kỳ hành trình iframe nào, tác vụ đó PHẢI cung cấp 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ỉ ĐƯỢ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 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 tuỳ chọn cục bộ do trình duyệt đặt nếu 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 thành bài nộp bằng thông tin đăng nhập của giáo viên đã lưu trữ (nên dùng) HOẶC khi giáo viên mở bài tập đã 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 PHẢI tuân thủ các nguyên tắc của WCAG 2.1 cấp AA về khả năng hỗ trợ 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à tiện ích bổ sung này tiếp tục tuân thủ các thay đổi trong tương lai đối với tiện ích bổ sung. ĐỀ 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 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ị một tệp đính kèm mới để học viên hoàn thành 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. ĐỀ XUẤT
4.0 Khám phá tệp đính kèm
  4.1 Nếu học viên phải nộp một tệp đính kèm, thì tệp đó PHẢI bao gồm studentWorkReviewUri để được coi là một loại hoạt động chứ không phải là tệp đính kèm loại nội dung. BẮT BUỘC
  4,2 iframe của tính năng 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 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 trên 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 có sẵn cho giáo viên. ĐỀ XUẤT
  4,4 Giáo viên PHẢI có thể xem trướ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 thực hiện tác vụ để 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. ĐỀ 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.
ĐỀ 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 thao tác để đánh dấu bài tập đã hoàn thành, thì nút này 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ể xem nội dung mà học viên sẽ thấy khi làm bài tập. ĐỀ XUẤT
7,0 Kiểm tra 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 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 di chuyển giữa các học viên trong khung hiển thị studentWorkReviewUri. Việc điều hướng giữa các học viên PHẢI chỉ 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 một 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 đều phải liên kết sâu đến đúng chế độ xem. Nếu thiết bị không được hỗ trợ, một thông báo PHẢI được 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 là những thiết bị nào được hỗ trợ. BẮT BUỘC
  8.2 Bài tập của học viên PHẢI có thể hoàn thành trên thiết bị di động. ĐỀ 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 là đường liên kết, bạn NÊN nâng cấp đường liên kết lên tiện ích bổ sung đính kèm. ĐỀ XUẤT
  9.2 Nếu sử dụng công cụ tích hợp 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ả đường liên kết tương thích với tiện ích bổ sung của bạn. ĐỀ XUẤT

Nhật ký thay đổi

Phiên bản 1.0 Cập nhật vào ngày 30/4/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 Bổ sung 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 thành hai yêu cầu mới.
4,2 Mở rộng nội dung mô tả về các 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. 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 Đượ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 các đường liên kết được dán vào 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 trên 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 vào 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 trong đó yêu cầu 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 bản sao khoá học và hướng dẫn nên dùng 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 Sửa văn bản để rõ ràng hơn ý định.
3.1 Đã thêm "The add-on PHẢI tuân thủ nguyên tắc phê duyệt GWM chung đã tìm thấy trên trang web của họ."
3,9 WCAG đã thay đổi BẮT BUỘC thành NÊN DÙNG.
5.1 Đã thay đổi BẮT BUỘC thành NÊN DÙNG.
5.3 Đã thêm thông báo "If the add-ons cậu ra khỏi iframe, CÓ PHẢI have a Preview about the task in the iframe."
5,4 Thêm thông báo "If the add-on Nội dung bật ra khỏi khung nội tuyến, có NÊN là lời nhắc dành cho học viên quay lại Lớp học."
8.1 Đã thêm "If the device is supported, a message NOT be showing to the user to allow they biết it's an unmanaged device and reasons, what devices are supported" (Những thiết bị được hỗ trợ).
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 vào ngày 22/9/2021
  Bản phát hành đầu tiên.