Pièces jointes liées à l'activité

Il s'agit du cinquième tutoriel de la série de tutoriels sur les modules complémentaires Classroom.

Dans ce tutoriel, vous allez modifier l'exemple de l'étape précédente pour générer un rattachement de type activité. Il s'agit des pièces jointes qui nécessitent l'envoi d'un devoir par un élève, comme une réponse écrite, un questionnaire ou tout autre artefact généré par l'élève.

La distinction entre les pièces jointes type de contenu et type d'activité est importante. Les pièces jointes de type activité diffèrent du type de contenu de la manière suivante:

• Le bouton "Rendre" s'affiche en haut à droite de l'iFrame de la vue élève.
• Ils permettent d'identifier de manière unique les devoirs des élèves.
• La fiche de la pièce jointe s'affiche dans l'interface utilisateur de l'outil de notation de Classroom.
• Ils peuvent attribuer une note au devoir auquel ils appartiennent.

Pour en savoir plus sur la notation, consultez le tutoriel suivant. Au cours de ce tutoriel, vous allez effectuer les opérations suivantes:

• Modifiez les précédentes demandes de création de pièces jointes envoyées à l'API Classroom pour créer un rattachement de type activité.
• Mettre en place un stockage persistant pour les devoirs des élèves
• Modifiez l'itinéraire précédent pour la vue élève afin d'accepter les entrées des élèves.
• Indiquez un itinéraire pour diffuser l'iFrame de révision des devoirs des élèves.

Une fois l'opération terminée, vous pouvez créer des pièces jointes de type activité aux devoirs via l'interface utilisateur de Google Classroom lorsque vous êtes connecté en tant qu'enseignant. Les élèves de la classe peuvent également terminer l'activité dans l'iFrame et envoyer une réponse. L'enseignant peut afficher le travail de l'élève dans l'interface de notation de Classroom.

Pour les besoins de cet exemple, réutilisez le modèle de pièce jointe du tutoriel précédent, qui montre une image d'un point de repère célèbre et une légende avec le nom de ce point de repère. L'activité consiste à demander à l'élève de fournir le nom du point de repère.

Modifier la demande de création de pièce jointe

Accédez à la section de votre code dans laquelle vous avez créé un rattachement de type contenu dans le tutoriel précédent. L'élément clé ici est une instance d'un objet AddOnAttachment, dans laquelle nous avons précédemment spécifié les paramètres teacherViewUri, studentViewUri et title du rattachement.

Bien que tous les rattachements de modules complémentaires nécessitent ces trois champs, la présence ou l'absence d'un élément studentWorkReviewUri détermine si le rattachement est de type activité ou de type contenu. Une requête CREATE dont le champ studentWorkReviewUri est renseigné devient un rattachement de type activité, tandis qu'une requête CREATE sans studentWorkReviewUri devient un rattachement de type contenu.

La seule modification à apporter à cette requête consiste à renseigner le champ studentWorkReviewUri. Ajoutez ici une route nommée de manière appropriée. Vous l'implémenterez plus tard.

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}",
}

Ajouter un espace de stockage persistant pour les pièces jointes liées au type de contenu

Enregistrez sa réponse à notre activité. Vous pourrez le consulter ultérieurement, lorsque l'enseignant consultera le devoir dans l'iFrame de révision des devoirs des élèves.

Configurez un schéma de base de données pour un Submission. Dans l'exemple fourni, les élèves doivent saisir le nom du point de repère affiché sur une image. Un Submission contient donc les attributs suivants:

• attachment_id: identifiant unique d'un rattachement. Attribué par Classroom et renvoyé dans la réponse lors de la création d'une pièce jointe.
• submission_id: identifiant associé au travail d'un élève. Attribué par Classroom et renvoyé dans la réponse getAddOnContext dans la vue élève.

• student_response: réponse fournie par l'élève.

# 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))

Modifier le parcours de la vue élève

Ensuite, modifiez l'itinéraire précédent pour la vue élève afin d'afficher un petit formulaire et d'accepter l'entrée de l'élève. Vous pouvez réutiliser la majeure partie du code du tutoriel précédent.

Recherchez le code du serveur qui fournit l'itinéraire pour la vue élève. Il s'agit de la route spécifiée dans le champ studentViewUri lors de la création d'un rattachement. La première modification à effectuer consiste à extraire submissionId de la réponse getAddOnContext.

# 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")

Vous pouvez également envoyer une demande pour connaître l'état du devoir remis par un élève. La réponse contient une valeur SubmissionState, qui indique des états indiquant par exemple si l'élève a ouvert ou rendu la pièce jointe. Cela peut être utile si vous souhaitez interdire les modifications d'un devoir remis ou si vous souhaitez fournir aux enseignants des informations sur la progression de leurs élèves:

# 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()

Enfin, extrayez les informations des pièces jointes de notre base de données et envoyez un formulaire de saisie. Le formulaire de l'exemple fourni comprend un champ de saisie de chaîne et un bouton d'envoi. Montrez l'image du point de repère et invitez l'élève à saisir son nom. Une fois leur réponse reçue, enregistrez-la dans notre base de données.

# 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)

Ajouter une route pour l'iFrame d'évaluation des devoirs des élèves

Enfin, ajoutez un itinéraire pour diffuser l'iFrame de révision des devoirs des élèves. Le nom de cette route doit correspondre à celui fourni pour le studentWorkReviewUri lors de la création d'un rattachement. Ce parcours s'ouvre lorsque l'enseignant consulte le devoir de l'élève dans l'interface utilisateur de l'outil de notation de Classroom.

Vous recevez le paramètre de requête submissionId lorsque Classroom ouvre l'iFrame de révision des devoirs des élèves. Utilisez-le pour récupérer le travail de l'élève à partir de votre base de données locale:

@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)

Tester le module complémentaire

Répétez les étapes du module complémentaire Tester les étapes du module complémentaire du tutoriel précédent. Vous devez fournir une pièce jointe qui peut être ouverte par l'élève.

Pour tester la pièce jointe de l'activité, procédez comme suit:

• Connectez-vous à Google Classroom en tant qu'utilisateur test élève dans la même classe que l'utilisateur test de l'enseignant.
• Accédez à l'onglet Travaux et devoirs et développez le devoir test.
• Cliquez sur la fiche de pièce jointe du module complémentaire pour ouvrir la vue élève et envoyer une réponse à l'activité.
• Fermez l'iFrame une fois l'activité terminée. Vous pouvez également cliquer sur le bouton Rendre.

Vous ne devriez constater aucun changement dans Classroom une fois l'activité terminée. À présent, testez l'iFrame de révision des devoirs des élèves:

• Connectez-vous à Classroom en tant qu'utilisateur test enseignant.
• Recherchez la colonne correspondant à votre devoir de test dans l'onglet Notes. Cliquez sur le nom de votre devoir de test.
• Recherchez la fiche de l'élève test. Cliquez sur la pièce jointe de la fiche.

Vérifiez que le devoir correct s'affiche pour l'élève.

Félicitations ! Vous êtes prêt à passer à l'étape suivante: synchroniser les notes associées aux pièces jointes.