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 một đường liên kết dưới dạng Tệp đính kèm đường liên kết trên 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 bằng 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 bằng 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 đã 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 chứa 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 đã cấp quyền cho ứng dụng của bạn)

4 tham số truy vấn đầu tiên phản ánh các tham số truy vấn đã khởi chạy trên iframe của tính năng Khám phá tệp đính kèm. Tham số truy vấn urlToUpgrade là tham 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 tải để cho giáo viên biết rằng tiện ích bổ sung đính kèm đang được tạo.

Sau khi tạo tệp đính kèm của 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ố chi tiết kỹ thuật quan trọng của tính năng này.

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

Tham số truy vấn urlToUpgrade được mã hoá URI khi truyền trên iframe nâng cấp đường liên kết. Bạn phải giải mã URL để có được URL ở dạng ban đầu. Chẳng hạn, nếu đang sử dụng JavaScript, bạn có thể sử dụng hàm decodeURIComponent() để thực hiện 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 khi dùng 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 triển khai iframe để biết thêm thông tin chi tiết.

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 nâng cấp đường liên kết: Đây là URL sẽ mở trong iframe khi giáo viên đồng ý nâng cấp.
Các mẫu URL mà Lớp học sẽ phát hiện và tìm cách 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 không cung cấp tiền tố đường dẫn nào, bạn có thể nâng cấp mọi URL khớp với máy chủ lưu trữ.
- Bạn chỉ có thể nâng cấp các URL có giao thức https.
- Mẫu URL không được chứa localhost.
- Tiền tố đường dẫn không được chứa các tham số truy vấn hoặc đoạn URL.
- Hiện tại, tiền tố đường dẫn có thể hỗ trợ ký tự đại diện, nhưng máy chủ thì không:
  - example.com là một máy chủ lưu trữ hợp lệ, còn /foo và /bar/*/baz là các 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 có 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ẫ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à kết quả khớp hợp lệ cho mẫu URL.
  - https://example.com/bar/123/baz/456/789 là 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/.

Quá trình phát triển

Gửi URL iframe của Link Upgrade và các mẫu URL cho tiện ích bổ sung thử nghiệm hoặc phát hành công khai của bạn bằng cách gửi email đến classroom-link-upgrade-external@google.com.

Trước tiên, bạn có thể cung cấp cấu hình cho tiện ích bổ sung riêng tư cũng như mọi môi trường thử nghiệm hoặc phát triển mà bạn sở hữu. Nhóm Lớp học có thể bật các cấu hình kiểm thử này trước khi bật cấu hình phát hành công khai để bạn có thể kiểm thử luồng trong miền minh hoạ của mình. Bạn sẽ nhận được thư phản hồi cho email của mình khi 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.

Hãy định dạng email để bao gồm các 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ế đoạn mã sau:

GCP_PROJECT_NUMBER: số dự án Google Cloud mà tiện ích bổ sung được liên kết.
LINK_UPGRADE_IFRAME_URL URL sẽ mở trong iframe Nâng cấp đường liên kết.
HOST_1: một máy chủ lưu trữ mà Lớp học sẽ phát hiện. Chỉ hỗ trợ giao thức https.
PATH_PREFIX_1 và PATH_PREFIX_2: các 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ột máy chủ lưu trữ mà Lớp học sẽ phát hiện. Chỉ hỗ trợ giao thức https.
PATH_PREFIX_3 và PATH_PREFIX_4: các 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à những đề xuất để bạn cân nhắc khi triển khai tính năng này.

Tránh làm thêm việc cho giáo viên

Bạn nên sử dụng iframe để tạo điều kiện đă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, giáo viên không nên được nhắc cung cấp thêm bất kỳ thông tin nào sau khi đã đồng ý nâng cấp đường liên kết đã dán lên tệp đính kèm có tiện ích bổ sung. Tuy nhiên, nếu tiện ích bổ sung của bạn không làm được như vậy, 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ình cần. Bạn cũng có thể sử 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.

Gửi kèm các thông báo lỗi khi truy cập theo cách thân thiện với 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ông báo lỗi thân thiện với người dùng trong iframe để giáo viên biết được vấn đề này. Bạn cũng có thể dùng iframe để cấp cho giáo viên quyền truy cập thích hợp vào nội dung.