活動類型附件

這是 Classroom 外掛程式操作說明系列的第五篇操作說明。

在本逐步操作說明中,您將修改上一個逐步操作步驟中的範例,產生活動類型附件。這些是需要學生提交的任何附件,例如書面回覆、測驗或其他學生產生的成果。

請務必區分內容類型和活動類型附件。活動類型附件與內容類型附件有以下差異:

  • 「提交」按鈕會顯示在學生檢視畫面 iframe 的右上方。
  • 這些 ID 可為學生作業提供專屬 ID。
  • 學生的附件資訊卡會顯示在 Classroom 評分工具 UI 中。
  • 他們可以為自己所屬的作業設定成績。

請參閱下一個逐步操作說明,瞭解評分方式。在本逐步操作說明中,您將完成下列操作:

  • 修改先前傳送至 Classroom API 的附件建立要求,以建立活動類型附件。
  • 為學生提交內容實作永久儲存空間。
  • 修改先前的學生檢視畫面路徑,接受學生輸入內容。
  • 提供路徑,以便提供學生作業評論 iframe。

完成後,您可以以老師身分登入 Google Classroom 使用者介面,為作業建立活動類型附件。課程中的學生也可以在 iframe 中完成活動,並提交回覆。老師可以在 Classroom 評分 UI 中查看學生提交的內容。

為了說明本範例,我們會重複使用上一個逐步操作說明中的附件範本,其中顯示著名地標的圖片和標註,標註中包含地標的名稱。活動內容包括提示學生提供地標名稱。

修改附件建立要求

前往您在上一個逐步操作說明中建立內容類型附件的程式碼部分。這裡的關鍵項目是 AddOnAttachment 物件的例項,我們先前已為附件指定 teacherViewUristudentViewUrititle

雖然所有外掛程式附件都需要這三個欄位,但studentWorkReviewUri 的存在或缺少會決定附件是活動類型還是內容類型。填入 studentWorkReviewUriCREATE 要求會成為活動類型附件,而沒有 studentWorkReviewUriCREATE 要求則會成為內容類型附件。

您只需要填入 studentWorkReviewUri 欄位,即可修改這項要求。在此新增適當命名的路徑,您會在後續步驟中實作。

Python

在我們提供的範例中,這項屬性位於 webapp/attachment_routes.py 檔案中的 create_attachments 方法中。

attachment = {
    # Specifies the route for a teacher user.
    "teacherViewUri": {
        "uri":
            flask.url_for(
                "load_activity_attachment",
                _scheme='https',
                _external=True),
    },
    # Specifies the route for a student user.
    "studentViewUri": {
        "uri":
            flask.url_for(
                "load_activity_attachment",
                _scheme='https',
                _external=True)
    },
    # Specifies the route for a teacher user when the attachment is
    # loaded in the Classroom grading view.
    # The presence of this field marks this as an activity-type attachment.
    "studentWorkReviewUri": {
        "uri":
            flask.url_for(
                "view_submission", _scheme='https', _external=True)
    },
    # The title of the attachment.
    "title": f"Attachment {attachment_count}",
}

為內容類型附件新增永久儲存空間

記錄學生對活動的回應。您稍後可以透過「學生作業評估」iframe 查看老師的評語。

Submission 設定資料庫結構定義。在提供的範例中,學生需要輸入圖片中顯示的地標名稱。因此,Submission 包含下列屬性:

  • attachment_id:附件的專屬 ID。由 Classroom 指派,並在建立附件時傳回在回應中。
  • submission_id:學生提交作業的 ID。由 Classroom 指派,並在學生檢視畫面的 getAddOnContext 回應中傳回。
  • student_response:學生提供的答案。

Python

擴充先前步驟中的 SQLite 和 flask_sqlalchemy 實作項目。

前往您定義先前資料表的檔案 (如果您是按照我們的範例操作,請前往 models.py)。在檔案底部新增以下內容。

# Database model to represent a student submission.
class Submission(db.Model):
    # The attachmentId is the unique identifier for the attachment.
    submission_id = db.Column(db.String(120), primary_key=True)

    # The unique identifier for the student's submission.
    attachment_id = db.Column(db.String(120), primary_key=True)

    # The student's response to the question prompt.
    student_response = db.Column(db.String(120))

將新的 Submission 類別匯入至含有附件處理路徑的伺服器檔案。

修改學生檢視畫面路徑

接下來,請修改先前的學生檢視路徑,以便顯示小型表單並接受學生的輸入內容。您可以重複使用先前逐步操作說明中的大部分程式碼。

找出提供學生檢視畫面路徑的伺服器程式碼。這是建立附件時在 studentViewUri 欄位中指定的路徑。首先要做的變更是從 getAddOnContext 回應中擷取 submissionId

Python

在我們提供的範例中,這項屬性位於 webapp/attachment_routes.py 檔案的 load_activity_attachment 方法中。

# Issue a request to the courseWork.getAddOnContext endpoint
addon_context_response = classroom_service.courses().courseWork(
).getAddOnContext(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"]).execute()

# One of studentContext or teacherContext will be populated.
user_context = "student" if addon_context_response.get(
    "studentContext") else "teacher"

# If the user is a student...
if user_context == "student":
    # Extract the submissionId from the studentContext object.
    # This value is provided by Google Classroom.
    flask.session["submissionId"] = addon_context_response.get(
            "studentContext").get("submissionId")

您也可以提出要求,取得學生提交作業的狀態。回應包含 SubmissionState 值,指出學生是否已開啟或繳交附件等狀態。如果您想禁止編輯已繳交的作業,或是想提供老師學生學習進度的洞察資料,這項功能就很實用:

Python

在我們提供的範例中,這是上述 load_activity_attachment 方法的延續。

# Issue a request to get the status of the student submission.
submission_response = classroom_service.courses().courseWork(
).addOnAttachments().studentSubmissions().get(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"],
    attachmentId=flask.session["attachmentId"],
    submissionId=flask.session["submissionId"]).execute()

最後,從資料庫擷取附件資訊,並提供輸入表單。我們提供的範例表單包含字串輸入欄位和提交按鈕。顯示地標圖片,並提示學生輸入地標名稱。對方回覆後,請將回覆內容記錄在資料庫中。

Python

在我們提供的範例中,這是上述 load_activity_attachment 方法的延續。

# Look up the attachment in the database.
attachment = Attachment.query.get(flask.session["attachmentId"])

message_str = f"I see that you're a {user_context}! "
message_str += (
    f"I've loaded the attachment with ID {attachment.attachment_id}. "
    if user_context == "teacher" else
    "Please complete the activity below.")

form = activity_form_builder()

if form.validate_on_submit():
    # Record the student's response in our database.

    # Check if the student has already submitted a response.
    # If so, update the response stored in the database.
    student_submission = Submission.query.get(flask.session["submissionId"])

    if student_submission is not None:
        student_submission.student_response = form.student_response.data
    else:
        # Store the student's response by the submission ID.
        new_submission = Submission(
            submission_id=flask.session["submissionId"],
            attachment_id=flask.session["attachmentId"],
            student_response=form.student_response.data)
        db.session.add(new_submission)

    db.session.commit()

    return flask.render_template(
        "acknowledge-submission.html",
        message="Your response has been recorded. You can close the " \
            "iframe now.",
        instructions="Please Turn In your assignment if you have " \
            "completed all tasks."
    )

# Show the activity.
return flask.render_template(
    "show-activity-attachment.html",
    message=message_str,
    image_filename=attachment.image_filename,
    image_caption=attachment.image_caption,
    user_context=user_context,
    form=form,
    responses=response_strings)

為了區分使用者,建議您停用提交函式,改為在「老師檢視畫面」中顯示正確答案。

為學生作業評論 iframe 新增路徑

最後,請新增路徑,以便提供學生作業評論 iframe。這個路徑的名稱應與建立附件時提供給 studentWorkReviewUri 的名稱相符。老師在 Classroom 評分工具使用者介面中查看學生繳交的作業時,就會開啟這個路徑。

當 Classroom 開啟「學生作業評論」iframe 時,您會收到 submissionId 查詢參數。您可以使用這項功能,從本機資料庫中擷取學生的作品:

Python

在我們提供的範例中,這項資訊位於 webapp/attachment_routes.py 檔案中。

@app.route("/view-submission")
def view_submission():
    """
    Render a student submission using the show-student-submission.html template.
    """

    # Save the query parameters passed to the iframe in the session, just as we did
    # in previous routes. Abbreviated here for readability.
    add_iframe_query_parameters_to_session(flask.request.args)

    # For the sake of brevity in this example, we'll skip the conditional logic
    # to see if we need to authorize the user as we have done in previous steps.
    # We can assume that the user that reaches this route is a teacher that has
    # already authorized and created an attachment using the add-on.

    # In production, we recommend fully validating the user's authorization at
    # this stage as well.

    # Look up the student's submission in our database.
    student_submission = Submission.query.get(flask.session["submissionId"])

    # Look up the attachment in the database.
    attachment = Attachment.query.get(student_submission.attachment_id)

    # Render the student's response alongside the correct answer.
    return flask.render_template(
        "show-student-submission.html",
        message=f"Loaded submission {student_submission.submission_id} for "\
            f"attachment {attachment.attachment_id}.",
        student_response=student_submission.student_response,
        correct_answer=attachment.image_caption)

測試外掛程式

重複執行上一個示範課程中的測試外掛程式步驟。您應該有學生可以開啟的附件。

如要測試活動附件,請完成下列步驟:

  • 學生測試使用者的身分登入 Google Classroom,並與老師測試使用者在同一班級。
  • 前往「課堂作業」分頁,然後展開「作業」
  • 按一下外掛程式附件資訊卡,開啟學生檢視畫面,然後提交活動回覆。
  • 完成活動後關閉 iframe。視需要按一下「提交」按鈕。

完成活動後,Classroom 應該不會有任何變動。接著測試學生作業評論 iFrame:

  • 老師測試使用者身分登入 Classroom。
  • 在「成績」分頁中找出測驗作業的欄位。按一下測驗作業的名稱。
  • 找出測試學生使用者的資訊卡。按一下資訊卡上的附件。

確認學生的作業內容正確無誤。

恭喜!您可以開始進行下一個步驟:同步附件成績