外部添付ファイルと提出

Classroom アドオンに関する 7 番目のチュートリアル 説明します。

このチュートリアルでは、ウェブ アプリケーションにアドオンを作成する Google Classroom の外部にある添付ファイル。この動作を使用して、 ユーザーが既存のプロダクトまたはウェブサイトからアドオンの添付ファイルを作成します。これは、 また、既存のサービスを直接管理できるため、CourseWork との統合にも最適です。 変更することなく、アドオンによって強化されたユーザー エクスペリエンスにトラフィックを移行できます。 できます。推奨される手順については、添付ファイルを作成する Classroom の外部をご覧ください。

また、アドオンで割り当てを変更する動作をアドオンに追加します。 行うことができます。割り当てられている割り当ては、 課題の作成者に関係なく、アドオン添付ファイルに記録されます。これは、 特に、生徒が修了後に課題を提出する場合に特に便利です。 割り当てられたタスクが完了したことを教師に通知し、 チェックできる状態になっています。

content-type または activity-type のアタッチメント。このガイドでは、content-type の添付ファイルを使用します。

割り当て管理の OAuth スコープを追加する

アプリケーションが次のスコープをリクエストしていることを確認します。

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

classroom.coursework.students スコープは、以前は不要であり、 CourseWork 割り当てを作成または変更するために使用します。このスコープをリストに追加する スコープが 1 つまたは複数 Google Workspace Marketplace SDKOAuth 同意画面、および 構成する必要があります。

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

Classroom で課題を作成する

iframe のないウェブページにボタンを追加する

このチュートリアルで説明するフローでは、 Google 以外のサービスからの Google Classroom の課題と添付ファイル。イン おそらく既存のウェブサイトやアプリケーションで 活用してくださいこの例では、 外部サイトとして機能する疑似ウェブページを作成する必要があります。ボタンが必要です またはリンクをクリックすると、推奨されるルートを実行する新しいルートが開きますCourseWork フローに沿って新しい課題を作成します。

ユーザーがログインするためのボタンまたはリンクを追加することも必要です。 作成しますこれ以降の操作をするには、ユーザーの認証情報が必要です。 OAuth 2.0 handshake を完了する必要があります。ログイン チュートリアルをご覧ください。

Python

提供されている Python の例では、導入された /index ルートを変更します チュートリアルの最初のステップをご覧ください。

<!-- /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>

ウェブサイト内のリンク先を表す HTML テンプレートを追加します。このページ CourseWork に添付されるコンテンツを表します。 割り当てます。

<!-- /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>

CourseWork 関連のルートを処理する新しい Python モジュール ファイルを作成します。 上記の例では、これは coursework_routes.py です。以下を追加します。 3 つのルートがあります。内容の一部は後で入力します。

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

ユーザーがアドオンを作成できるかどうかを確認する

ユーザーを作成するには、いくつかの前提条件を満たす必要があります。 アドオン添付ファイルの委任をユーザーに委任できます利便性のために、Google は courses.checkAddOnCreationEligibility メソッド: ユーザーが 要件を満たす必要があります。前提条件を満たすユーザーは 要件を満たしているユーザー

CourseWork 作成ルートの実装に適格性チェックを追加します。 次に、レスポンスの isCreateAttachmentEligible フィールドをテストします。対象 ロジックに従ってアドオン付きの割り当てを作成する 添付ファイルをご覧ください。それ以外の場合は、リンク 素材。コースの ID を知っておく必要があります。 割り当てを作成します。通常、ユーザーは 使用するコースを指定しますわかりやすくするため、ここでは変数にハードコードされた 説明します。

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.

対象ユーザーのアドオン添付ファイルを含む課題を作成する

お客様がアドオンの添付ファイルを作成できる場合は、次の操作を行います。

  1. courseWork の割り当てを作成する API リクエストを送信します。 Google Classroom。添付ファイルは不要です
  2. 新しく作成した課題の id を抽出します。
  3. 新しい CourseWork AddOnAttachment を作成します。
  4. 新しく作成したサービス アカウントにアドオンの添付ファイルを作成するリクエストを送信します。 学びます。
で確認できます。

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

ユーザーにアドオンの添付ファイルを作成する資格がない場合は、リンクを作成します。 代わりに、次の手順に沿ってマテリアルを使用します。

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

作成済みの課題を変更する

ユーザーは、どの Google Classroom にもアクセス、変更、提出、再利用、返却を行うことができます。 少なくとも 1 つのアドオン添付ファイルを含むストリーム アイテムが必要です。 ユーザーがストリーム アイテムを作成しました。ストリーム アイテムは任意の AnnouncementCourseWork です 割り当て、または CourseWorkMaterial です。

これを示すために、特定のストリーム アイテムを変更するルートを追加します。使用する メソッドを使用して、作成したストリーム アイテムにアクセスして変更できることを確認します。 API を使用して作成されており、かつ、Google Classroom の UI で教師が作成する。

最初に編集したウェブページにリンクまたはボタンを 1 つ以上追加します 説明します。CourseWork を変更するための新しいルートが開きます。 割り当てます。

Python

提供されている Python の例では、変更された /index ルートを変更します こちらで前述しました。

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

CourseWork 関連のルートを処理する新しいルートを作成します。これは 上記の例では、coursework_routes.py ファイルが作成されます。

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

アドオンをテストする

わかりやすくするために、提供されている例では、ハードコードされたコースと 割り当て識別子。これらの識別子は、 coursesget メソッドと list メソッドに対する教師の認証情報 courseWork リソース。また、インスタンスの作成時にもレスポンスで courseWork 件の課題。

サーバーを実行します。インデックス ページに移動し、教師ユーザーとしてログインします。 Google Workspace for Education のLearning ライセンスまたは Plus ライセンスが必要です。 テストドメインのユーザーから [Create a CourseWork Assignment] をクリックします。 ボタンをクリックし、Google Classroom UI を開いて、課題が リンク マテリアルの添付ファイルが作成されました。添付ファイルのタイトルは リンク先のウェブページと URL です

アドオンの添付ファイルの作成をテストする

インデックス ページに戻り、Google Workspace for Education Teaching and Learning の教師ユーザーとしてログインします。 &amp;Learning ライセンスまたは Plus ライセンスが必要です。[Create a CourseWork Assignment] をクリックします。 ボタンをクリックし、Google Classroom UI を開いて、課題が アドオンの添付ファイルが作成されました。添付ファイルには、 アドオン アプリケーションとコード内で指定されているタイトルがダウンロードされます。

割り当ての変更をテストする

インデックス ページに戻り、教師ユーザーとしてログインしていることを確認します。 Teaching and Learning UpgradeLearning ライセンスまたは Plus ライセンスが必要です。[Modify a CourseWork 割り当て] ボタンをクリックし、Google Classroom の UI に戻って、 課題のタイトルが変更されています。

これで、チュートリアル シリーズを完了しました。