Tạo tệp đính kèm bên ngoài Google Lớp học

Hướng dẫn này trình bày cách 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 các điểm cuối API CourseWork. Triển khai hành trình này để cho phép người dùng tạo tệp đính kèm bằng tiện ích bổ sung từ trang web hoặc ứng dụng của bạn.

Luồng công việc

Nhìn chung, quy trình tạo tệp đính kèm tuân theo trình tự sau:

  1. 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.
  2. Kiểm tra để đảm bảo người dùng có thể tạo tệp đính kèm có tiện ích bổ sung.
  3. Nếu người dùng không thể tạo tệp đính kèm tiện ích bổ sung, hãy tạo bài tập CourseWork với URL đến nội dung đã chọn dưới dạng Tài liệu liên kết.
  4. Nếu người dùng có thể tạo tệp đính kèm có tiện ích bổ sung, hãy làm như sau:
    1. Tạo bài tập.
    2. Tạo một tệp đính kèm bổ sung liên kết đến nội dung đã chọn và liên kết tệp đính kèm đó với bài tập mới.
  5. Thông báo cho giáo viên rằng bài tập đã được tạo thành công.

Mỗi hành động đượ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 có tiện ích bổ sung hay không

Bạn có thể thay mặt cho một người dùng đủ điều kiện để tạo tệp đính kèm có tiện ích bổ sung. 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 Google Workspace for Education Teaching & Learning hoặc Education Plus.

Bắt đầu bằng cách xác định xem người dùng có thể tạo tệp đính kèm có tiện ích bổ sung hay không. Bạn có thể làm như vậy bằng cách đưa ra yêu cầu đến điểm cuối userProfiles.checkUserCapability bằng tham số chức năng CREATE_ADD_ON_ATTACHMENT. Kiểm tra trường boolean allowed trong phản hồi; giá trị true cho biết người dùng đủ điều kiện tạo tệp đính kèm tiện ích bổ sung.

Python

eligibility_response = (
  classroom_service.userProfiles()
  .checkUserCapability(
    userId="me",
    capability="CREATE_ADD_ON_ATTACHMENT",
    # The previewVersion is necessary while the method is available in the
    # Workspace Developer Preview Program.
    previewVersion="V1_20240930_PREVIEW",
  ).execute()
)
is_create_attachment_eligible = (
  eligibility_response.get('allowed')
)
print(f'User eligibility for course {course_id}'
      f': {is_create_attachment_eligible}.')

Chuyển hướng người dùng dựa trên điều kiện của họ

Tiêu chí sử dụng xác định liệu bạn có thể tạo tệp đính kèm có tiện ích bổ sung 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 tiện ích bổ sung, hãy tạo một bài tập CourseWork mới với URL nội dung do người dùng chọn dưới dạng 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 chứa một bài tập trong khoá học được yêu cầu kèm theo nội dung. Người dùng có thể nhấp vào Link để mở nội dung trong trang web của bạn trong một thẻ mới.

Bài tập CourseWork nháp có Tài liệu liên kết

Hình 1. Chế độ xem của giáo viên về bài tập CourseWork nháp có Tài liệu liên kết.

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 có tiện ích bổ sung.

  1. Tạo một bài tập CourseWork mới mà không có tệp đính kèm nào.
  2. Tạo tệp đính kèm của tiện ích bổ sung.

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 sẽ xuất hiện dưới dạng thẻ tệp đí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.