ส่งไฟล์แนบภายนอก

นี่คือคำแนะนำแบบทีละขั้นที่ 7 ในส่วนเสริมของ Classroom คำแนะนำแบบทีละขั้น

ในคำแนะนำแบบทีละขั้นนี้ คุณจะเพิ่มลักษณะการทำงานลงในเว็บแอปพลิเคชันเพื่อสร้างส่วนเสริม ไฟล์แนบจากภายนอก Google Classroom ใช้ลักษณะการทำงานนี้เพื่อให้ ผู้ใช้จะสร้างไฟล์แนบของส่วนเสริมจากผลิตภัณฑ์หรือเว็บไซต์ที่มีอยู่ได้ นี่คือ และยังเป็นตัวช่วยที่ยอดเยี่ยมสำหรับการผสานรวม CourseWork เนื่องจากคุณ การเข้าชมไปยังประสบการณ์ของผู้ใช้ที่ดีขึ้นซึ่งส่วนเสริมของคุณเสนอโดยไม่เปลี่ยนแปลง ความลื่นไหลของพวกเขา โปรดดูกระบวนการที่แนะนำในสร้างไฟล์แนบ ภายนอก Classroom ในหน้าคำแนะนำ

คุณยังเพิ่มลักษณะการทำงานลงในส่วนเสริมเพื่อแก้ไขงานด้วยส่วนเสริมได้ด้วย โดยอัตโนมัติ คุณแก้ไขงานที่มี ไฟล์แนบของส่วนเสริม ไม่ว่าใครจะเป็นผู้สร้างงานก็ตาม นี่คือ มีประโยชน์อย่างยิ่งในการส่งงานหลังจากที่นักเรียนทำ กิจกรรม ซึ่งส่งสัญญาณให้ครูทราบว่างานที่มอบหมายเสร็จสมบูรณ์แล้ว และ งานของนักเรียนพร้อมให้ตรวจสอบแล้ว

คุณขยายส่วนเสริมเวอร์ชันสุดท้ายที่รองรับประเภทเนื้อหา หรือ ไฟล์แนบประเภทกิจกรรม ไฟล์แนบประเภทเนื้อหาจะใช้ในคู่มือนี้

เพิ่มขอบเขต 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 รายการ เพิ่มขอบเขตนี้ลงในรายการ ของขอบเขตใน SDK ของ Google Workspace Marketplace, หน้าจอขอความยินยอม OAuth และ รหัสเซิร์ฟเวอร์

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 Classroom และไฟล์แนบจากผลิตภัณฑ์ที่ไม่ใช่ของ Google ใน ให้ทำเช่นนั้นได้ เป็นไปได้ว่านี่คือเว็บไซต์หรือแอปพลิเคชันที่คุณมีอยู่ สำหรับตัวอย่างนี้ คุณต้องสร้างหน้าเว็บจำลองเพื่อดำเนินการเป็นเว็บไซต์ภายนอก คุณต้องมีปุ่ม หรือลิงก์ที่เมื่อคลิกจะเปิดเส้นทางใหม่ซึ่งดำเนินการตามคำแนะนำ CourseWork ขั้นตอนเพื่อสร้างงานใหม่

นอกจากนี้คุณจะต้องเพิ่มปุ่มหรือลิงก์เพื่อให้ผู้ใช้ลงชื่อเข้าใช้ได้ด้วยหากคุณ หากยังไม่มี คุณจะต้องใช้ข้อมูลเข้าสู่ระบบของผู้ใช้เพื่อดำเนินการ คำขอ API จึงต้องทำแฮนด์เชค OAuth 2.0 ให้เสร็จสมบูรณ์ ดูการลงชื่อเข้าใช้ คำแนะนำแบบทีละขั้นสำหรับหลักเกณฑ์ที่เฉพาะเจาะจง

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>

สร้างไฟล์โมดูล Python ใหม่เพื่อจัดการเส้นทางที่เกี่ยวข้องกับ CourseWork นี่คือ 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 ในคำตอบ สำหรับที่มีสิทธิ์ ให้ผู้ใช้ ให้ทำตามตรรกะเพื่อสร้างงานที่มีส่วนเสริม ไฟล์แนบ หรือสร้างลิงก์ สื่อการเรียนการสอนของชั้นเรียน คุณจำเป็นต้องทราบรหัสของหลักสูตรใน ที่ผู้ใช้ต้องการสร้างงาน โดยปกติแล้ว คุณจะแจ้งผู้ใช้ เพื่อระบุว่าจะใช้หลักสูตรใด เพื่อความง่าย เราจะใช้ค่าฮาร์ดโค้ดใน ในตัวอย่างนี้

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. ส่งคำขอ API เพื่อสร้างการมอบหมาย courseWork ใน Google Classroom ที่ไม่มีไฟล์แนบ
  2. ดึงข้อมูล id ของงานที่สร้างใหม่
  3. สร้าง CourseWork AddOnAttachment ใหม่
  4. ส่งคำขอเพื่อสร้างไฟล์แนบของส่วนเสริมในไฟล์ที่สร้างขึ้นใหม่ งานใน Google Classroom

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 ไฟล์ ไม่ว่าใครก็ตาม สร้างรายการสตรีมแล้ว รายการสตรีมคือ Announcement, CourseWork หรือ CourseWorkMaterial

ในการสาธิตนี้ คุณจะต้องเพิ่มเส้นทางเพื่อแก้ไขรายการสตรีมที่ระบุ ใช้ร่างคำตอบนี้ เพื่อยืนยันว่าคุณเข้าถึงและแก้ไขรายการสตรีมที่คุณสร้างได้ โดยใช้ API และที่ครูสร้างขึ้นผ่าน UI ของ Google Classroom

เพิ่มลิงก์หรือปุ่มอีก 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()
)

ทดสอบส่วนเสริม

เพื่อให้ง่ายขึ้น ตัวอย่างที่ให้ไว้ใช้หลักสูตรที่ฮาร์ดโค้ดและ ตัวระบุงานที่มอบหมาย คุณสามารถดูตัวระบุเหล่านี้ได้โดยส่งคำขอด้วย ข้อมูลเข้าสู่ระบบของครูสำหรับเมธอด get และ list ของ courses และ ทรัพยากร courseWork และจะแสดงการตอบกลับด้วยเมื่อสร้าง courseWork งาน

เรียกใช้เซิร์ฟเวอร์ จากนั้นไปที่หน้าดัชนีและลงชื่อเข้าใช้ในฐานะผู้ใช้ของครู หากไม่มี Google Workspace for Education Teaching and Learning หรือ Plus คุณสามารถสลับ สถานะใบอนุญาตของผู้ใช้จากโดเมนทดสอบ คอนโซลผู้ดูแลระบบ คลิกสร้างงานในหลักสูตร จากนั้นเปิด UI ของ Google Classroom และยืนยันว่างานที่มี สร้างไฟล์แนบ Material ของลิงก์แล้ว ไฟล์แนบควรแสดงชื่อของ หน้าเว็บและ URL ที่ลิงก์

ทดสอบการสร้างไฟล์แนบของส่วนเสริม

กลับไปที่หน้าดัชนีและลงชื่อเข้าใช้ในฐานะผู้ใช้ที่เป็นครูด้วย Google Workspace for Education Teaching &amp; Learning หรือ Plus คลิกสร้างงานในหลักสูตร จากนั้นเปิด UI ของ Google Classroom และยืนยันว่างานที่มี สร้างไฟล์แนบของส่วนเสริมแล้ว ไฟล์แนบควรแสดงชื่อของ แอปพลิเคชันส่วนเสริมและชื่อที่ระบุไว้ในโค้ดของคุณ

ทดสอบการแก้ไขการมอบหมาย

กลับไปที่หน้าดัชนีและตรวจสอบว่าได้ลงชื่อเข้าใช้ในฐานะผู้ใช้ของครู ด้วยหลักสูตร Learning หรือ Plus คลิกแก้ไขงานของหลักสูตร งาน แล้วจึงกลับไปที่ UI ของ Google Classroom และยืนยันว่า เปลี่ยนชื่องานแล้ว

ยินดีด้วย คุณดำเนินชุดคำแนะนำแบบทีละขั้นจบแล้ว