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

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

ภาพรวม

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

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

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

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

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

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

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

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

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