Hướng dẫn này đề cập đến việc tạo tệp đính kèm bằng tiện ích bổ sung trong trang web hoặc ứng dụng của bạn. Các hoạt động tương tác này tương tự như tạo bài tập bằng điểm cuối của API CourseWork. Hãy triển khai hành trình này để cho phép người dùng tạo tiện ích bổ sung đính kèm trên trang web hoặc ứng dụng của bạn.
Quy trình làm việc
Nhìn chung, hành trình tạo tệp đính kèm tuân theo trình tự sau:
- Người dùng là giáo viên mở trang web hoặc ứng dụng của bạn. Họ chọn một nội dung để giao cho học viên.
- Kiểm tra để đảm bảo rằng người dùng có thể tạo tiện ích bổ sung tệp đính kèm.
- Nếu người dùng không thể tạo tệp đính kèm bằng tiện ích bổ sung, hãy tạo một bài tập trên CourseWork có URL đến nội dung đã chọn dưới dạng một Tài liệu đường liên kết.
- Nếu người dùng có thể tạo tệp đính kèm bằng tiện ích bổ sung, hãy làm như sau:
- Tạo bài tập.
- Tạo một tệp đính kèm bằng tiện ích bổ sung liên kết với nội dung đã chọn rồi liên kết nội dung đó với bài tập mới.
- Thông báo cho giáo viên rằng bài tập đã được tạo thành công.
Mỗi thao tác được mô tả trong các phần sau.
Kiểm tra xem người dùng có thể tạo tệp đính kèm bằng tiện ích bổ sung hay không
Bạn có thể tạo tiện ích bổ sung đính kèm thay mặt cho người dùng đủ điều kiện. Người dùng đủ điều kiện là người dùng là giáo viên trong khoá học mà bạn đang cố gắng tạo bài tập trong CourseWork và được cấp giấy phép phiên bản Teaching & Learning hoặc Education Plus của Google Workspace for Education.
Bắt đầu bằng cách xác định xem người dùng có thể tạo tiện ích bổ sung trong một Course
nhất định hay không.
Gửi yêu cầu đến điểm cuối courses.checkAddOnCreationEligibility
, bao gồm cả Mã khoá học.
Python
eligibility_response = (
classroom_service.courses()
.checkAddOnCreationEligibility(courseId=course_id)
.execute()
)
is_create_attachment_eligible = (
eligibility_response.get('isCreateAttachmentEligible')
)
print(f'User eligibility for course {eligibility_response.get("courseId")}'
f': {is_create_attachment_eligible}.')
Nếu người dùng đủ điều kiện, phản hồi sẽ chứa giá trị boolean isCreateAttachmentEligible
được đặt thành true
. Nếu người dùng không đủ điều kiện, phản hồi sẽ không trả về giá trị boolean isCreateAttachmentEligible
.
Định tuyến người dùng dựa trên điều kiện sử dụng
Việc bạn có đủ điều kiện tạo tệp đính kèm bằng tiện ích bổ sung hay không sẽ quyết định xem bạn có thể tạo tệp đính kèm cho người dùng hay không.
Người dùng không đủ điều kiện
Nếu người dùng không thể tạo tệp đính kèm bằng tiện ích bổ sung, hãy tạo một lượt chỉ định CourseWork
mới với URL nội dung do người dùng chọn là Link
.
Python
if not is_create_attachment_eligible:
coursework = {
'title': 'My CourseWork Assignment with Link Material',
'description': 'Created using the Classroom CourseWork API.',
'workType': 'ASSIGNMENT',
'state': 'DRAFT', # Set to 'PUBLISHED' to assign to students.
'maxPoints': 100,
'materials': [
{'link': {'url': my_content_url}}
]
}
assignment = (
service.courses()
.courseWork()
.create(courseId=course_id, body=coursework)
.execute()
)
print(
f'Link Material assignment created with ID: {assignment.get("id")}'
)
Phản hồi có chứa một bài tập trong khoá học được yêu cầu có đính kèm nội dung. Người dùng có thể nhấp vào Link
để mở nội dung trên trang web của bạn trong một thẻ mới.
Hình 1. Chế độ xem của giáo viên về một bài tập bản nháp của Bài tập trên lớp có đường liên kết trong tài liệu.
Người dùng đủ điều kiện
Hãy làm như sau nếu người dùng có thể tạo tệp đính kèm bằng tiện ích bổ sung.
- Tạo một bài tập
CourseWork
mới mà không có tệp đính kèm. - Tạo tệp đính kèm bằng tiện ích bổ sung.
- Đặt
itemId
củaAddOnAttachment
thànhid
của bài tập mới tạo. - Đảm bảo rằng bạn cung cấp URL đến nội dung do người dùng chọn cho từng Chế độ xem mà bạn hỗ trợ.
- Đặt
Python
if is_create_attachment_eligible:
coursework = {
'title': 'My CourseWork Assignment with Add-on Attachment',
'description': 'Created using the Classroom CourseWork API.',
'workType': 'ASSIGNMENT',
'state': 'DRAFT', # Set to 'PUBLISHED' to assign to students.
'maxPoints': 100,
}
assignment = (
classroom_service.courses()
.courseWork()
.create(courseId=course_id, body=coursework)
.execute()
)
print(
f'Empty assignment created with ID: {assignment.get("id")}'
)
attachment = {
'teacherViewUri': {'uri': teacher_view_url},
'studentViewUri': {'uri': student_view_url},
'studentWorkReviewUri': {'uri': grade_student_work_url},
'title': f'Test Attachment {test_label}',
}
add_on_attachment = (
service.courses()
.courseWork()
.addOnAttachments()
.create(
courseId=course_id,
itemId=assignment.get("id"), # ID of the new assignment.
body=attachment,
)
.execute()
)
print(
f'Add-on attachment created with ID: {add_on_attachment.get("id")}'
)
Tiện ích bổ sung này xuất hiện dưới dạng thẻ đính kèm trong Lớp học. Các URL được chỉ định trong yêu cầu sẽ mở trong iframe thích hợp cho mỗi Chế độ xem.