Nộp tệp đính kèm bên ngoài và nộp

Đây là hướng dẫn hướng dẫn thứ bảy trong loạt hướng dẫn từng bước về tiện ích bổ sung trên Google Lớp học.

Trong hướng dẫn từng bước này, bạn sẽ thêm hành vi vào một ứng dụng web để tạo tệp đính kèm tiện ích bổ sung từ bên ngoài Google Lớp học. Hãy sử dụng hành vi này để cho phép người dùng tạo tệp đính kèm bằng tiện ích bổ sung từ sản phẩm hoặc trang web hiện có của bạn. Đây cũng là một tính năng bổ sung tuyệt vời cho việc tích hợp CourseWork vì bạn hướng lưu lượng truy cập hiện có đến trải nghiệm người dùng được cải tiến do tiện ích bổ sung của bạn cung cấp mà không làm thay đổi luồng của chúng. Quy trình đề xuất được trình bày trên trang hướng dẫn Tạo tệp đính kèm bên ngoài Lớp học.

Bạn cũng thêm hành vi vào tiện ích bổ sung để sửa đổi bài tập bằng các tệp đính kèm tiện ích bổ sung theo phương thức lập trình. Bạn có thể sửa đổi bất kỳ bài tập nào có một trong các tệp đính kèm bằng tiện ích bổ sung, bất kể ai là người tạo bài tập. Điều này đặc biệt hữu ích khi học sinh nộp bài tập sau khi học sinh hoàn thành một hoạt động, báo hiệu cho giáo viên biết rằng các bài tập được giao đã hoàn thành và bài tập của học sinh đã sẵn sàng để đánh giá.

Bạn mở rộng phiên bản cuối cùng của tiện ích bổ sung để hỗ trợ tệp đính kèm loại nội dung hoặc tệp đính kèm loại hoạt động. Tệp đính kèm loại nội dung được sử dụng trong hướng dẫn này.

Thêm phạm vi OAuth quản lý bài tập

Đảm bảo rằng ứng dụng của bạn yêu cầu các phạm vi sau:

  • https://www.googleapis.com/auth/classroom.addons.teacher
  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.coursework.students

Trước đây, phạm vi classroom.coursework.students không cần thiết cho hoạt động này. Phạm vi này được dùng để tạo hoặc sửa đổi thông tin chỉ định CourseWork. Thêm phạm vi này vào danh sách phạm vi trong SDK Google Workspace Marketplace, màn hình xin phép của OAuth và mã máy chủ của dự án trên đám mây.

Python

  SCOPES = [
    "https://www.googleapis.com/auth/classroom.addons.teacher",
    "https://www.googleapis.com/auth/classroom.addons.student",
    "https://www.googleapis.com/auth/classroom.coursework.students",
  ]

Tạo một bài tập trong Lớp học

Thêm các nút vào một trang web không có iframe

Quy trình được mô tả trong phần hướng dẫn từng bước này cho phép người dùng tạo bài tập và tệp đính kèm trên Google Lớp học bằng một sản phẩm không phải của Google. Trên thực tế, đây có thể là trang web hoặc ứng dụng hiện có của bạn. Đối với ví dụ này, bạn cần tạo một trang web mô phỏng để hoạt động như một trang web bên ngoài. Khi được nhấp vào, bạn cần có một nút hoặc đường liên kết sẽ mở một tuyến mới thực hiện quy trình CourseWork được đề xuất để tạo một bài tập mới.

Bạn cũng cần thêm nút hoặc đường liên kết để cho phép người dùng đăng nhập nếu chưa có. Bạn sẽ cần thông tin xác thực của người dùng để thực hiện các yêu cầu API tiếp theo. Vì vậy, họ phải hoàn tất giao dịch bắt tay OAuth 2.0. Xem hướng dẫn đăng nhập để biết hướng dẫn cụ thể.

Python

Ví dụ Python đã cung cấp sửa đổi tuyến /index được giới thiệu trong bước hướng dẫn từng bước đầu tiên.

<!-- /webapp/templates/index.html -->
<a href="clear-credentials.html">Logout</a>
<a href="start-auth-flow.html">Login</a>

<br>

<a href="create-coursework-assignment.html">Create a CourseWork Assignment</a>

Thêm mẫu HTML để đại diện cho một đích đến trong trang web của bạn. Trang này sẽ đại diện cho nội dung sẽ được đính kèm vào bài tập CourseWork của bạn.

<!-- /webapp/templates/example-coursework-assignment.html -->
<h1>CourseWork assignment loaded!</h1>
<p>You've loaded a CourseWork assignment! It was created from an external web page.</p>

Tạo một tệp mô-đun Python mới để xử lý các tuyến liên quan đến CourseWork. Đây là coursework_routes.py trong ví dụ chúng tôi cung cấp. Thêm 3 tuyến sau đây; lưu ý rằng bạn sẽ điền một số nội dung sau.

# /webapp/coursework_routes.py
@app.route("/create-coursework-assignment")
def create_coursework_assignment():
  """
  Completes the assignment creation flow.
  """

  # Check that the user is signed in. If not, perform the OAuth 2.0
  # authorization flow.
  credentials = get_credentials()

  if not credentials:
    return start_auth_flow("coursework_assignment_callback")

  # Construct the Google Classroom service.
  classroom_service = get_classroom_service()

  pass  # To be completed later.

@app.route("/example-coursework-assignment/<assignment_type>")
def example_coursework_assignment(assignment_type):
  """
  Renders the "example-coursework-assignment.html" template.
  """
  return flask.render_template(
      "example-coursework-assignment.html", assignment_type=assignment_type
  )

@app.route("/coursework-assignment-callback")
def coursework_assignment_callback():
  """
  Completes the OAuth 2.0 handshake and stores credentials in the session.
  This is identical to the callback introduced in the sign-in walkthrough,
  but redirects the user to the index page instead of the attachment
  discovery page.
  """
  flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
      CLIENT_SECRETS_FILE,
      scopes=SCOPES,
      state=flask.session["state"],
      redirect_uri=flask.url_for("coursework_assignment_callback", _external=True),
  )

  flow.fetch_token(authorization_response=flask.request.url)

  credentials = flow.credentials
  flask.session["credentials"] = session_credentials_to_dict(
      credentials
  )

  # Close the current window and redirect the user to the index page.
  return flask.render_template("close-me.html", redirect_destination="index")

Kiểm tra điều kiện tạo tiện ích bổ sung của người dùng

Người dùng phải đáp ứng một số điều kiện tiên quyết thì bạn mới có thể thay mặt họ tạo tệp đính kèm bằng tiện ích bổ sung. Để thuận tiện, Google cung cấp phương thức courses.checkAddOnCreationEligibility để xác định xem người dùng có đáp ứng những điều kiện tiên quyết này hay không. Người dùng đáp ứng các điều kiện tiên quyết được gọi là người dùng đủ điều kiện.

Thêm bước kiểm tra điều kiện vào quy trình triển khai tuyến tạo CourseWork. Sau đó, hãy kiểm thử trường isCreateAttachmentEligible trong phản hồi. Đối với người dùng đủ điều kiện, hãy làm theo logic để tạo một bài tập có chứa tệp đính kèm tiện ích bổ sung. Nếu không, hãy tạo một Tài liệu liên kết. Bạn cần phải biết mã nhận dạng của khoá học mà người dùng muốn tạo bài tập. Thông thường, bạn sẽ nhắc người dùng chỉ định khoá học nào sẽ sử dụng. Để đơn giản, chúng tôi sẽ sử dụng một giá trị được mã hoá cứng trong ví dụ này.

Python

# /webapp/coursework_routes.py
@app.route("/create-coursework-assignment")
def create_coursework_assignment():
  """
  Completes the assignment creation flow.
  """
  # ... Check that the user is signed in and get the Classroom service ...

  # The ID of the course to which the assignment will be added.
  course_id = 1234567890  # TODO(developer) Replace with an actual course ID.

  # Check whether the user can create add-on attachments.
  eligibility_response = (
      classroom_service.courses()
      .checkAddOnCreationEligibility(courseId=course_id)
      .execute()
  )
  is_create_attachment_eligible = eligibility_response.get("isCreateAttachmentEligible")

  if is_create_attachment_eligible:
    # See the "Create an assignment with add-on attachment for eligible users" section for implementation.
  if not is_create_attachment_eligible:
    # See the "Create a Link Material" section for implementation.

Tạo bài tập có tiện ích bổ sung đính kèm cho người dùng đủ điều kiện

Nếu người dùng đủ điều kiện tạo tệp đính kèm bằng tiện ích bổ sung, hãy làm như sau:

  1. Gửi yêu cầu API để tạo bài tập courseWork trong Google Lớp học mà không có tệp đính kèm.
  2. Trích xuất id của bài tập mới tạo.
  3. Tạo một CourseWork AddOnAttachment mới.
  4. Gửi yêu cầu tạo tệp đính kèm bằng tiện ích bổ sung cho bài tập mới tạo trong Google Lớp học.

Python

# /webapp/coursework_routes.py
if is_create_attachment_eligible:
  # Create an assignment.
  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.
  }

  # Issue a request to create the assignment.
  create_assignment_response = (
      classroom_service.courses()
      .courseWork()
      .create(courseId=course_id, body=coursework)
      .execute()
  )

  # Create an add-on attachment that links to the selected content and
  # associate it with the new assignment.
  content_url = flask.url_for(
      "example_coursework_assignment",
      assignment_type="add-on-attachment",
      _scheme="https",
      _external=True,
  )

  # Construct an AddOnAttachment instance.
  attachment = {
      "teacherViewUri": {"uri": content_url},
      "studentViewUri": {"uri": content_url},
      "title": f'Test Attachment for Assignment {create_assignment_response.get("id")}',
  }

  # Issue a request to create the attachment.
  add_on_attachment_response = (
      classroom_service.courses()
      .courseWork()
      .addOnAttachments()
      .create(
          courseId=course_id,
          itemId=create_assignment_response.get("id"),  # ID of the new assignment.
          body=attachment,
      )
      .execute()
  )

Nếu người dùng không đủ điều kiện tạo tệp đính kèm bằng tiện ích bổ sung, hãy tạo Tài liệu liên kết bằng cách làm như sau:

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.
        # Specify the URL for your content as a Link Material.
        "materials": [
            {
                "link": {
                    "url": flask.url_for(
                        "example_coursework_assignment",
                        assignment_type="link-material",
                        _scheme="https",
                        _external=True,
                    )
                }
            }
        ],
    }

    # Issue a request to create the assignment.
    assignment_response = (
        classroom_service.courses()
        .courseWork()
        .create(courseId=course_id, body=coursework)
        .execute()
    )

Sửa đổi bài tập đã tạo

Bạn có thể truy cập, sửa đổi, nộp, lấy lại hoặc trả về mọi mục luồng dữ liệu trong Google Lớp học có ít nhất một trong các tệp đính kèm của tiện ích bổ sung, bất kể ai đã tạo mục đó. Các mục trong luồng là bất kỳ nội dung chỉ định Announcement, CourseWork hoặc CourseWorkMaterial nào.

Để chứng minh điều này, bạn sẽ thêm một tuyến để sửa đổi một mục cụ thể trong luồng. Hãy sử dụng phương thức này để xác minh rằng bạn có thể truy cập và sửa đổi các mục trong luồng do bạn tạo bằng API giáo viên tạo thông qua giao diện người dùng Google Lớp học.

Thêm một đường liên kết hoặc nút khác vào trang web mà bạn chỉnh sửa lần đầu trong hướng dẫn từng bước này. Thao tác này sẽ mở một tuyến mới để sửa đổi hoạt động gán CourseWork.

Python

Ví dụ về Python được cung cấp sửa đổi tuyến /index đã được sửa đổi trước đó trong phần hướng dẫn từng bước này.

<!-- /webapp/templates/index.html -->
<a href="modify-coursework-assignment.html">Create a CourseWork Assignment</a>

Tạo một tuyến mới để xử lý các tuyến liên quan đến CourseWork. Đây là tệp coursework_routes.py trong ví dụ chúng tôi cung cấp.

# Check that the user is signed in.
credentials = get_credentials()

if not credentials:
  return start_auth_flow("coursework_assignment_callback")

# Get the Google Classroom service.
classroom_service = get_classroom_service()

# The ID of the course to which the assignment will be added.
# Ordinarily, you'll prompt the user to specify which course to use. For
# simplicity, we use a hard-coded value in this example.
course_id = 1234567890  # TODO(developer) Replace with an actual course ID.
assignment_id = 1234567890  # TODO(developer) Replace with an actual assignment ID.

# Retrieve details about the CourseWork assignment.
get_coursework_response = (
    classroom_service.courses()
    .courseWork()
    .get(courseId=course_id, id=assignment_id)
    .execute()
)

# Alter the current title.
assignment_title = f"{get_coursework_response.get('title')} (Modified by API request)"

# Issue a request to modify the assignment.
modify_coursework_response = (
    classroom_service.courses()
    .courseWork()
    .patch(
        courseId=course_id,
        id=assignment_id,
        updateMask="title",
        body={"title": assignment_title},
    )
    .execute()
)

Kiểm thử tiện ích bổ sung

Để đơn giản, các ví dụ được cung cấp sẽ sử dụng giá trị nhận dạng khoá học và bài tập được mã hoá cứng. Bạn có thể nhận các giá trị nhận dạng này bằng cách đưa ra yêu cầu bằng thông tin đăng nhập của giáo viên vào phương thức getlist của các tài nguyên coursescourseWork. Các giá trị này cũng được trả về trong phản hồi khi tạo các bài tập courseWork.

Chạy máy chủ của bạn, sau đó chuyển đến trang chỉ mục rồi đăng nhập với tư cách là người dùng giáo viên không có giấy phép Teaching & Learning hoặc Plus của Google Workspace for Education. Bạn có thể bật/tắt trạng thái giấy phép của người dùng trên Bảng điều khiển dành cho quản trị viên của miền thử nghiệm.Nhấp vào nút Create a CourseWork Assignment, sau đó mở giao diện người dùng của Google Lớp học và xác minh rằng bài tập có tệp đính kèm Link Material đã được tạo. Tệp đính kèm phải cho thấy tiêu đề của trang web được liên kết và một URL.

Kiểm thử việc tạo tệp đính kèm bằng tiện ích bổ sung

Quay lại trang chỉ mục rồi đăng nhập với tư cách là người dùng giáo viên có giấy phép Teaching and Learning hoặc Plus của Google Workspace for Education. Nhấp vào nút Create a CourseWork Assignment (Tạo bài tập trên Khoá học), sau đó mở giao diện người dùng Google Lớp học và xác minh rằng bài tập có tệp đính kèm có tiện ích bổ sung đã được tạo. Tệp đính kèm phải cho thấy tên của ứng dụng tiện ích bổ sung và tiêu đề được chỉ định trong mã của bạn.

Kiểm thử việc sửa đổi chỉ định

Quay lại trang chỉ mục và đảm bảo rằng bạn đã đăng nhập với tư cách là người dùng giáo viên có giấy phép Teaching & Learning hoặc Plus. Nhấp vào nút Modify a CourseWork Assignment (Sửa đổi bài tập) sau đó quay lại giao diện người dùng Google Lớp học và xác minh rằng tên bài tập đã được thay đổi.

Xin chúc mừng! Bạn đã hoàn tất loạt hướng dẫn từng bước.