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