Hiện tại, các nhà phát triển đã có thể sử dụng rộng rãi tiện ích bổ sung của Google Lớp học! Vui lòng xem tài liệu về tiện ích bổ sung để biết thêm thông tin.

Trang này được dịch bởi Cloud Translation API.

Nâng cấp tệp đính kèm trong Link lên tiện ích bổ sung của Lớp học đính kèm

Một cách để giáo viên thêm nội dung của bên thứ ba vào Lớp học là dán đường liên kết dưới dạng Tệp đính kèm đường liên kết trong trang tạo bài tập. Để xây dựng dựa trên những gì giáo viên đã quen thuộc, giờ đây, bạn có thể định cấu hình tiện ích bổ sung để cho phép giáo viên nâng cấp tệp đính kèm Đường liên kết thành tệp đính kèm tiện ích bổ sung.

Tổng quan

Nếu bạn định cấu hình tiện ích bổ sung có chức năng này, giáo viên sẽ được nhắc nâng cấp đường liên kết thành tệp đính kèm tiện ích bổ sung khi họ dán tệp đính kèm Đường liên kết vào trang tạo bài tập. Giáo viên chỉ được nhắc làm như vậy nếu họ đã cài đặt tiện ích bổ sung.

Sau khi giáo viên đồng ý nâng cấp đường liên kết thành tệp đính kèm tiện ích bổ sung, iframe Nâng cấp đường liên kết sẽ được khởi chạy với các tham số truy vấn sau:

courseId
itemId
itemType
addOnToken
urlToUpgrade
login_hint (chỉ khi người dùng đã cho phép ứng dụng của bạn)

Bốn tham số truy vấn đầu tiên phản ánh các tham số truy vấn được khởi chạy trên iframe Khám phá tệp đính kèm. Thông số truy vấn urlToUpgrade là thông số mới và có thể giúp bạn đánh giá cách tạo tệp đính kèm của tiện ích bổ sung. Sau đó, bạn có thể sử dụng các tham số truy vấn khác để kiểm tra xem người dùng đã đăng nhập hay chưa và gọi phương thức CreateAddOnAttachment của courseWork, courseWorkMaterials hoặc announcements dựa trên giá trị itemType. Trong iframe, bạn có thể hiển thị màn hình đang tải để cho giáo viên biết rằng tệp đính kèm của tiện ích bổ sung đang được tạo.

Sau khi tạo tệp đính kèm tiện ích bổ sung, iframe sẽ đóng và giáo viên có thể xem tệp đính kèm trong bài tập như bình thường.

Chi tiết triển khai kỹ thuật

Phần này nêu bật một số thông tin kỹ thuật quan trọng về tính năng này.

Đọc tham số truy vấn `urlToUpgrade`

Tham số truy vấn urlToUpgrade được mã hoá URI khi được truyền trên iframe Nâng cấp liên kết. Bạn phải giải mã URL để lấy URL ở dạng ban đầu. Ví dụ: nếu đang sử dụng JavaScript, bạn có thể sử dụng hàm decodeURIComponent() để làm việc này.

Đóng iframe Nâng cấp đường liên kết

Để đảm bảo người dùng có trải nghiệm tối ưu với tính năng này, hãy gửi postMessage sau khi tạo thành công tệp đính kèm của tiện ích bổ sung. Thao tác này sẽ đóng iframe. Hãy xem trang chi tiết về cách triển khai iframe để biết thêm thông tin.

Chi tiết cấu hình

Bạn cần có các cấu hình sau để tích hợp tính năng này vào tiện ích bổ sung:

URL cho iframe Đường liên kết nâng cấp: Đây là URL mở trong khung hiển thị khi giáo viên đồng ý nâng cấp.
Các mẫu URL mà Lớp học nên phát hiện và cố gắng nâng cấp: Các mẫu URL có thể bao gồm một máy chủ lưu trữ và nhiều tiền tố đường dẫn.
- Bạn có thể cung cấp nhiều mẫu URL.
- Nếu bạn không cung cấp tiền tố đường dẫn nào, thì mọi URL khớp với máy chủ lưu trữ đều có thể được nâng cấp.
- Chỉ những URL có giao thức https mới có thể được nâng cấp.
- Mẫu URL không được chứa localhost.
- Tiền tố đường dẫn không được chứa tham số truy vấn hoặc đoạn URL.
- Tiền tố đường dẫn có thể hỗ trợ ký tự đại diện tại thời điểm này, nhưng máy chủ lưu trữ thì không:
  - example.com là máy chủ lưu trữ hợp lệ, còn /foo và /bar/*/baz là tiền tố đường dẫn hợp lệ.
  - example.*.host.com không phải là máy chủ lưu trữ hợp lệ.
- Ký tự đại diện giữa các thành phần tiền tố đường dẫn chỉ khớp với một thành phần và không khớp với nhiều thành phần được phân tách bằng dấu gạch chéo. Hãy xem xét một mẫu URL có máy chủ lưu trữ example.com và tiền tố đường dẫn /bar/*/baz:
  - https://example.com/bar/123/baz là một kết quả khớp hợp lệ cho mẫu URL.
  - https://example.com/bar/123/baz/456/789 là một kết quả khớp hợp lệ cho mẫu URL.
  - https://example.com/bar/123/456/baz không phải là kết quả khớp hợp lệ cho mẫu URL vì ký tự đại diện trong tiền tố đường dẫn không khớp với /123/456/.

Quy trình phát triển

Gửi URL iframe và mẫu URL của tính năng Nâng cấp đường liên kết cho tiện ích bổ sung thử nghiệm hoặc công khai bằng cách gửi email đến classroom-link-upgrade-external@google.com.

Bạn có thể cung cấp cấu hình cho mọi dự án trên Google Cloud đại diện cho một tiện ích bổ sung của Lớp học. Trước tiên, bạn nên cung cấp cấu hình cho tiện ích bổ sung có chế độ hiển thị riêng tư để có thể phát triển và thử nghiệm trong miền minh hoạ mà không ảnh hưởng đến người dùng thực tế.

Bạn sẽ nhận được email phản hồi khi các cấu hình đã được bật. Xin lưu ý rằng các mẫu URL sử dụng localhost không được hỗ trợ cho tính năng này.

Định dạng email để bao gồm những thông tin sau:

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
-   Host:HOST_1
-   Path prefixes:
  -   PATH_PREFIX_1
  -   PATH_PREFIX_2

-   Host:HOST_2
-   Path prefixes:
  -   PATH_PREFIX_3
  -   PATH_PREFIX_4

// add more hosts and path prefixes as needed

Thay thế nội dung sau:

GCP_PROJECT_NUMBER: Số dự án trên Google Cloud mà tiện ích bổ sung được liên kết.
LINK_UPGRADE_IFRAME_URL: URL sẽ mở trong khung hiển thị nội dung nhúng Nâng cấp đường liên kết.
HOST_1: Máy chủ mà Lớp học sẽ phát hiện. Chỉ hỗ trợ giao thức https.
PATH_PREFIX_1 và PATH_PREFIX_2: Tiền tố đường dẫn liên kết với HOST_1 mà Lớp học sẽ phát hiện và cố gắng nâng cấp.
HOST_2: Máy chủ mà Lớp học sẽ phát hiện. Chỉ hỗ trợ giao thức https.
PATH_PREFIX_3 và PATH_PREFIX_4: Tiền tố đường dẫn liên kết với HOST_2 mà Lớp học sẽ phát hiện và cố gắng nâng cấp.

Trải nghiệm người dùng được đề xuất

Sau đây là một số đề xuất cần cân nhắc khi triển khai tính năng này.

Tránh gây thêm công việc cho giáo viên

Bạn nên sử dụng iframe để hỗ trợ đăng nhập (nếu cần) hoặc hiển thị chỉ báo tải. Để mang lại trải nghiệm tốt nhất cho người dùng, bạn không nên nhắc giáo viên cung cấp thêm thông tin sau khi họ đồng ý nâng cấp đường liên kết đã dán thành tệp đính kèm bổ sung. Tuy nhiên, nếu không thể thực hiện việc này cho tiện ích bổ sung, bạn có thể sử dụng iframe Nâng cấp đường liên kết để thu thập thêm thông tin mà bạn cần. Bạn cũng có thể dùng iframe để thông báo cho giáo viên nếu không thể nâng cấp đường liên kết hoặc nếu xảy ra lỗi.

Thêm thông báo lỗi truy cập dễ hiểu cho người dùng

Nếu giáo viên dán và nâng cấp một đường liên kết mà họ không có quyền truy cập, hãy hiển thị một thông báo lỗi dễ hiểu trong iframe để giáo viên biết được vấn đề. Bạn cũng có thể sử dụng iframe để cấp cho giáo viên các quyền thích hợp để truy cập vào nội dung.