อัปเกรดไฟล์แนบของลิงก์เป็นไฟล์แนบของส่วนเสริมของ Classroom

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

ภาพรวม

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

เมื่อครูตกลงที่จะอัปเกรดลิงก์ไปยังไฟล์แนบของส่วนเสริม iframe การอัปเกรดลิงก์จะเปิดขึ้นพร้อมพารามิเตอร์การค้นหาต่อไปนี้

  • courseId
  • itemId (เปลี่ยนชื่อจาก postId)
  • itemType (ใหม่!)
  • addOnToken
  • login_hint หรือ hd
  • urlToUpgrade (ใหม่!)

พารามิเตอร์การค้นหา 4 รายการแรกจะมิเรอร์พารามิเตอร์การค้นหาที่เรียกใช้ในiframe การค้นพบไฟล์แนบ พารามิเตอร์การค้นหา urlToUpgrade เป็นพารามิเตอร์ใหม่และช่วยให้คุณประเมินได้ว่าควรสร้างไฟล์แนบของส่วนเสริมอย่างไร จากนั้น คุณสามารถใช้พารามิเตอร์การค้นหาอื่นๆ เพื่อตรวจสอบว่าผู้ใช้ลงชื่อเข้าใช้หรือไม่ และเรียกเมธอด CreateAddOnAttachment ของ courseWork, courseWorkMaterials หรือ announcements ตามค่า itemType ใน iframe คุณสามารถแสดงหน้าจอการโหลดเพื่อบอกครูว่ากำลังสร้างไฟล์แนบของส่วนเสริม

เมื่อสร้างไฟล์แนบของส่วนเสริมแล้ว iframe จะปิดไปและครูจะดูไฟล์แนบในงานได้ตามปกติ

รายละเอียดการใช้งานทางเทคนิค

ส่วนนี้จะไฮไลต์รายละเอียดทางเทคนิคที่สำคัญสำหรับฟีเจอร์นี้

อ่านพารามิเตอร์การค้นหา urlToUpgrade

พารามิเตอร์การค้นหา urlToUpgrade จะเข้ารหัส URI เมื่อมีการส่งผ่านใน iframe การอัปเกรดลิงก์ คุณต้องถอดรหัส URL เพื่อให้ได้มาซึ่งอยู่ในรูปแบบเดิม เช่น หากใช้ JavaScript ก็ใช้ฟังก์ชัน decodeURIComponent() ได้

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

รายละเอียดการกำหนดค่า

คุณต้องกำหนดค่าต่อไปนี้เพื่อผสานรวมฟีเจอร์นี้ลงในส่วนเสริม

  • URL สำหรับ iframe การอัปเกรดลิงก์: URL นี้จะเปิดขึ้นใน iframe เมื่อครูตกลงที่จะอัปเกรด

  • รูปแบบ URL ที่ Classroom ควรตรวจพบและพยายามอัปเกรด: รูปแบบ URL อาจประกอบด้วยคำนำหน้าโฮสต์และคำนำหน้าเส้นทางหลายเส้นทาง

    • คุณสามารถระบุรูปแบบ URL ได้หลายรูปแบบ
    • หากไม่ระบุคำนำหน้าเส้นทาง คุณจะอัปเกรด URL ที่ตรงกับโฮสต์ได้
    • อัปเกรดได้เฉพาะ URL ที่มีรูปแบบ https เท่านั้น
    • รูปแบบ URL ต้องไม่มี localhost
    • คำนำหน้าเส้นทางต้องไม่มีพารามิเตอร์การค้นหาหรือส่วนย่อย URL
    • คำนำหน้าเส้นทางรองรับไวลด์การ์ดในขณะนี้ แต่โฮสต์จะทำสิ่งต่อไปนี้ไม่ได้
      • example.com เป็นโฮสต์ที่ถูกต้อง และ /foo และ /bar/*/baz เป็นคำนำหน้าเส้นทางที่ถูกต้อง
      • example.*.host.com ไม่ใช่โฮสต์ที่ถูกต้อง
    • ไวลด์การ์ดระหว่างคอมโพเนนต์คำนำหน้าเส้นทางจะจับคู่คอมโพเนนต์เดียวเท่านั้นและไม่ตรงกับคอมโพเนนต์หลายรายการที่คั่นด้วยเครื่องหมายทับ ลองพิจารณารูปแบบ URL ที่มีโฮสต์ example.com และคำนำหน้าเส้นทาง /bar/*/baz:
      • https://example.com/bar/123/baz คือการจับคู่ที่ถูกต้องสำหรับรูปแบบ URL
      • https://example.com/bar/123/baz/456/789 เป็นการจับคู่ที่ถูกต้องสำหรับรูปแบบ URL
      • https://example.com/bar/123/456/baz ไม่ใช่การจับคู่ที่ถูกต้องสำหรับรูปแบบ URL เนื่องจากไวลด์การ์ดในคำนำหน้าเส้นทางไม่ตรงกัน /123/456/

กระบวนการพัฒนา

ส่ง URL ของ iframe การอัปเกรดลิงก์และรูปแบบ URL สำหรับการทดสอบหรือส่วนเสริมเวอร์ชันที่ใช้งานจริงโดยส่งอีเมลไปที่ classroom-link-upgrade-external@google.com

โดยคุณจะระบุการกำหนดค่าสำหรับส่วนเสริมส่วนตัวและสภาพแวดล้อมการทดสอบหรือการพัฒนาที่คุณเป็นเจ้าของได้ก่อน ทีม Classroom สามารถเปิดใช้การกำหนดค่าการทดสอบเหล่านี้ก่อนเปิดใช้การกำหนดค่าเวอร์ชันที่ใช้งานจริงเพื่อให้คุณทดสอบขั้นตอนการใช้งานในโดเมนสาธิตได้ คุณจะได้รับการตอบกลับทางอีเมลเมื่อเปิดใช้การกำหนดค่าแล้ว โปรดทราบว่าฟีเจอร์นี้ไม่รองรับรูปแบบ URL ที่ใช้ localhost

จัดรูปแบบอีเมลให้มีข้อมูลต่อไปนี้

Google Cloud Project number: GCP_PROJECT_NUMBER

Link Upgrade iframe URL: LINK_UPGRADE_IFRAME_URL

URL Patterns:
- Host:HOST_1
- Path prefixes:
  - PATH_PREFIX_1
  - PATH_PREFIX_2

- Host:HOST_2
- Path prefixes:
  - PATH_PREFIX_3
  - PATH_PREFIX_4

// add more hosts and path prefixes as needed

แทนที่รายการต่อไปนี้

  • GCP_PROJECT_NUMBER: จำนวนโปรเจ็กต์ Google Cloud ที่เชื่อมโยงกับส่วนเสริม
  • LINK_UPGRADE_IFRAME_URL URL ที่ควรเปิดใน iframe ของ Link Upgrade
  • HOST_1: โฮสต์ที่ Classroom ควรตรวจพบ รองรับเฉพาะรูปแบบ https เท่านั้น
  • PATH_PREFIX_1 และ PATH_PREFIX_2: คำนำหน้าเส้นทางที่เชื่อมโยงกับ HOST_1 ที่ Classroom ควรตรวจพบและพยายามอัปเกรด
  • HOST_2: โฮสต์ที่ Classroom ควรตรวจพบ รองรับเฉพาะรูปแบบ https เท่านั้น
  • PATH_PREFIX_3และ PATH_PREFIX_4: คำนำหน้าเส้นทางที่เชื่อมโยงกับ HOST_2 ที่ Classroom ควรตรวจพบและพยายามอัปเกรด

ต่อไปนี้เป็นคำแนะนำที่ควรพิจารณาเมื่อใช้ฟีเจอร์นี้

หลีกเลี่ยงงานเพิ่มเติมให้ครู

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

รวมข้อความแสดงข้อผิดพลาดในการเข้าถึงที่ใช้งานง่าย

หากครูวางและอัปเกรดลิงก์ที่ตนไม่มีสิทธิ์เข้าถึง ให้แสดงข้อความแสดงข้อผิดพลาดที่เหมาะกับผู้ใช้ใน iframe เพื่อให้ครูทราบถึงปัญหา นอกจากนี้ยังสามารถใช้ iframe เพื่อให้สิทธิ์ที่เหมาะสมในการเข้าถึงเนื้อหาแก่ครู