Phiên bản 1.1, ngày 5 tháng 12 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Ẽ", "SẼ KHÔNG", "NÊN", "KHÔNG NÊN", "NÊN", "CÓ THỂ" và "KHÔNG BẮT BUỘC" trong tài liệu này đượ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 | Bạn NÊN cho người dùng thấy một thông báo thân thiện khi người dùng không có giấy phép. Thông báo NÊN nêu rõ lý do không thể sử dụng tiện ích bổ sung và đề xuất một cách hành động để người dùng khắc phục tình trạng này. | ĐƯỢC ĐỀ XUẤT | |
| 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 về giấy phép và gói thuê bao 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ó một cấp trả phí, thì trang thông tin trên Marketplace PHẢI cung cấp một đường liên kết đến trang web có thêm thông tin về giá hoặc cách liên hệ với nhân viên bán hàng. | ĐƯỢC ĐỀ XUẤT | |
| 2.0 | Đăng nhập của người dùng cuối | ||
| 2.1 | Người dùng là 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 (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 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 những 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 đ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à truyền login_hint đến thư viện uỷ quyền để 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 (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 các nguyên tắc sử dụng thương hiệu của Google, đồng thời 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Ổ TRỢ NÊN hiển thị thông tin về người dùng hiện đang đăng nhập. | ĐƯỢC ĐỀ XUẤT | |
| 3.0 | Tổng quan | ||
| 3.1 | Tiện ích bổ sung PHẢI tuân thủ các 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 khởi chạy vào một thẻ hoặc cửa sổ mới từ bất kỳ hành trình nào trong iframe, thì tác vụ đó PHẢI cung cấp một thông báo thân thiện với người dùng để quay lại Lớp học. | ĐƯỢC ĐỀ XUẤT | |
| 3.3 | Người dùng CHỈ ĐƯỢC hoàn tất quy trình bằng cách sử dụng quy trình làm việc của tiện ích bổ sung và không chuyển sang quy trình courseWork hoặc sử dụng Nút chia sẻ của 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 của người dùng địa phương do trình duyệt đặt khi có thể. | ĐƯỢC ĐỀ XUẤT | |
| 3,5 | Nếu xác định maxPoints, tiện ích bổ sung 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 đăng nhập đã lưu của giáo viên (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 | Các tiện ích BẮT BUỘC PHẢI tuân thủ các nguyên tắc về khả năng hỗ trợ tiếp cậ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 sẽ 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 ở định dạng mà con người có thể đọc được. | ĐƯỢC ĐỀ XUẤT | |
| 3.11 | Nếu studentViewUri, teacherViewUri hoặc studentWorkViewUri được khởi chạy từ một bài tậ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 | |
| 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 nộp bài, thì tệp đính kèm đó PHẢI có một studentWorkReviewUri để được coi là một loại hoạt động chứ không phải loại nội dung đính kèm. |
BẮT BUỘC | |
| 4,2 | Khung hiển thị nội tuyến Attachment Discovery PHẢI cung cấp một giao diện người dùng có ít nhất một trong những tính năng sau:
|
BẮT BUỘC | |
| 4,3 | Giáo viên CẦN có thể tìm 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 CẦN 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. | ĐƯỢC ĐỀ XUẤT | |
| 4,5 | Nếu giáo viên cần tạo nội dung/hoạt động trước khi có thể đính kèm, thì giáo viên NÊN hoàn thành việc đó trong iframe. | ĐƯỢC ĐỀ XUẤT | |
| 5.0 | Chế độ xem của học viên | ||
| 5.1 | Khi studentViewUri được khởi chạy, tiện ích bổ sung KHÔNG ĐƯỢC đưa người dùng ra khỏi iframe để hoàn tất một tác vụ.Nếu tiện ích bổ sung đưa người dùng ra khỏi iframe, thì PHẢI có một 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 bổ sung bật ra khỏi iframe, thì PHẢI có bản xem trước về tác vụ trong iframe. | ĐƯỢC ĐỀ XUẤT | |
| 5.3 | Nếu có, nút hoặc đường liên kết trong hoạt động có nhãn Nộp bài PHẢI khiến một yêu cầu API gửi bài tập của học viên để giáo viên xem xét. | BẮT BUỘC | |
| 6.0 | Chế độ xem của giáo viên | ||
| 6.1 | Giáo viên CẦN có thể xem những gì học viên sẽ thấy khi làm bài tập. | ĐƯỢC ĐỀ XUẤT | |
| 7.0 | Xem xét 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 ra 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 ở chế độ xem studentWorkReviewUri. Bạn CHỈ ĐƯỢC PHÉP chuyển đổi giữa các học viên trong giao diện người dùng Lớp học. |
BẮT BUỘC | |
| 8.0 | Hỗ trợ Lớp học trên thiết bị di động | ||
| 8.1 | Khi ứng dụng di động Lớp học 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 của đối tác hoặc ứng dụng web dành cho thiết bị di động của đối tác, đồng thời trong cả hai trường hợp, URL này 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 để cho họ biết đó là thiết bị không được hỗ trợ và tốt nhất là những thiết bị được hỗ trợ. |
BẮT BUỘC | |
| 8.2 | Học viên 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 NÊN chuyển đườ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 một chế độ tích hợp CourseWork để tạo bài tập bên ngoài Lớp học, thì bạn NÊN tạo tiện ích bổ sung đính kèm 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.1 | Cập nhật ngày 5 tháng 12 năm 2024 |
| 1.1, 1.3, 3.2, 3.10, 4.4, 5.2 | Đã thay đổi từ BẮT BUỘC thành ĐƯỢC ĐỀ XUẤT. |
| 3.12 | Đã xoá. |
| 5.3 | Đã diễn đạt lại. Một thay đổi gần đây cho phép nhà phát triển tiện ích bổ sung nộp bài tập của học viên một cách đáng tin cậy bằng API. |
| 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 yêu cầu 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ó 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 2 yêu cầu mới. |
| 4,2 | Mở rộng nội dung mô tả về những trải nghiệm được chấp nhận của tính năng Khám phá tệp đính kèm. |
| 4,3 | Được đánh số lại, trước đây là 4.2. Cũng thay đổi từ BẮT BUỘC thành ĐƯỢC ĐỀ XUẤT. |
| 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 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 | Chỉnh sửa hướng dẫn về gợi ý đăng nhập. |
| 2.4 | Đã kết hợp một tình huống mà bạn cần triển khai hd. |
| 3.2 | Đã diễn đạt lại "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à nên có về nội dung khoá học cho studentViewUri, teacherViewUri và studentWorkReviewUri. |
| 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 để thể hiện rõ hơn ý định. |
| 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ó trên trang web của họ". |
| 3,9 | WCAG đã thay đổi trạng thái BẮT BUỘC thành ĐƯỢC ĐỀ XUẤT. |
| 5.1 | Thay đổi từ BẮT BUỘC thành ĐỀ XUẤT. |
| 5.3 | Thêm "Nếu các 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ổ sung bật ra khỏi iframe, thì PHẢI có lời nhắc để học viên quay lại Lớp học." |
| 8.1 | Thêm "Nếu thiết bị không được hỗ trợ, thì một thông báo PHẢI được hiển thị cho 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ợ." |
| 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 ĐƯỢC ĐỀ XUẤT. |
| 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. |