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

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

ภาพรวม

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

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

  • courseId
  • itemId
  • itemType
  • addOnToken
  • urlToUpgrade
  • login_hint (เฉพาะในกรณีที่ผู้ใช้ให้สิทธิ์แอปของคุณแล้ว)

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

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

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

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

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

ระบบจะเข้ารหัส URI ของพารามิเตอร์การค้นหา urlToUpgrade เมื่อส่งใน iframe ของ Link Upgrade คุณต้องถอดรหัส URL เพื่อให้ได้ 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

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