ข้อกำหนดส่วนเสริม

เวอร์ชัน 1.1 วันที่ 5 ธ.ค. 2024

เกณฑ์ในหน้านี้ใช้กับส่วนเสริมทั้งหมดของ Classroom ส่วนเสริมของคุณ ต้อง เป็นไปตามรายการที่จำเป็นทั้งหมดที่เกี่ยวข้องจึงจะได้รับการอนุมัติให้แสดงใน Google Workspace Marketplace และเป็นส่วนเสริมที่ "ใช้งานได้กับ Classroom"

คำสำคัญในเอกสารนี้ ซึ่งได้แก่ "ต้อง" "ต้องไม่" "จำเป็น" "จะ" "จะไม่" "ควร" "ไม่ควร" "แนะนำ" "อาจ" และ "ไม่บังคับ" มีความหมายตามที่อธิบายไว้ใน RFC 2119

ข้อกำหนด

รหัส ประเภท
1.0 ใบอนุญาตผู้ใช้ปลายทาง (หากมี)
  1.1 ระบบ _ควร_ แสดงข้อความที่เข้าใจง่ายแก่ผู้ใช้เมื่อผู้ใช้ไม่มีใบอนุญาต ข้อความ _ควร_ ระบุเหตุผลที่ใช้ส่วนเสริมไม่ได้ไว้อย่างชัดเจน และแนะนำแนวทางปฏิบัติให้ผู้ใช้แก้ไขสถานการณ์ แนะนำ
  1.3 ข้อมูลใน Google Workspace Marketplace สำหรับส่วนเสริม _ควร_ ระบุรายละเอียดเกี่ยวกับข้อกำหนดด้านใบอนุญาตและการสมัครใช้บริการที่อาจจำเป็นต้องใช้ส่วนเสริม หากส่วนเสริมมีแพ็กเกจแบบชำระเงิน ข้อมูลใน Marketplace _ควร_ มีลิงก์ไปยังหน้าเว็บที่มีข้อมูลเพิ่มเติมเกี่ยวกับราคาหรือวิธีติดต่อพนักงานขาย แนะนำ
2.0 การลงชื่อเข้าใช้ของผู้ใช้ปลายทาง
  2.1 ผู้ใช้ที่เป็นครู _ต้อง_ ลงชื่อเข้าใช้ส่วนเสริมโดยใช้ Google SSO
หากระบบขอให้ผู้ใช้ที่เป็นนักเรียนลงชื่อเข้าใช้ส่วนเสริม ผู้ใช้ _ต้อง_ ลงชื่อเข้าใช้โดยใช้ Google SSO
ต้องระบุ
  2.2 ส่วนเสริม _ต้อง_ ใช้ Google SSO เพื่อลงชื่อเข้าใช้ผู้ใช้โดยอัตโนมัติในการเข้าชมครั้งต่อๆ ไปโดยไม่แสดงข้อความแจ้งให้เข้าสู่ระบบ
เมื่อคำแนะนำในการเข้าสู่ระบบไม่ตรงกับผู้ใช้ที่ลงชื่อเข้าใช้อยู่ในปัจจุบัน ส่วนเสริม _ต้อง_ แสดงปุ่มลงชื่อเข้าใช้ให้ผู้ใช้ และส่ง login_hint ไปยังไลบรารีการตรวจสอบสิทธิ์เพื่อกรองบัญชีที่ไม่ถูกต้องออก
ต้องระบุ
  2.7 เมื่อผู้ใช้ Classroom ยังไม่ได้ลงชื่อเข้าใช้ส่วนเสริม (ตามที่ระบุโดยดูจากคำแนะนำในการเข้าสู่ระบบ) ส่วนเสริม _ต้อง_ แสดงปุ่ม "ลงชื่อเข้าใช้ด้วย Google" เพื่อให้ผู้ใช้ดำเนินการอย่างชัดแจ้งเพื่อเริ่มกระบวนการลงชื่อเข้าใช้
หมายเหตุ: การดำเนินการนี้จำเป็นเพื่อให้เป็นไปตามหลักเกณฑ์การใช้แบรนด์ของ Google และยังช่วยหลีกเลี่ยงตัวบล็อกป๊อปอัปด้วย
ต้องระบุ
  2.8 ส่วนเสริม _ควร_ แสดงผู้ใช้ที่ลงชื่อเข้าใช้อยู่ในปัจจุบัน แนะนำ
3.0 ทั่วไป
  3.1 ส่วนเสริม _ต้อง_ เป็นไปตามหลักเกณฑ์ทั่วไปในการอนุมัติ Google Workspace Marketplace ต้องระบุ
  3.2 หากมีการเปิดงานในแท็บหรือหน้าต่างใหม่จากเส้นทาง iframe ใดก็ตาม งานดังกล่าว _ควร_ แสดงข้อความที่เข้าใจง่ายเพื่อกลับไปยัง Classroom แนะนำ
  3.3 ผู้ใช้ _ต้อง_ ทำตามเส้นทางโดยใช้เวิร์กโฟลว์ของส่วนเสริมเท่านั้น และไม่เปลี่ยนไปใช้เวิร์กโฟลว์ของ CourseWork หรือใช้ปุ่มแชร์ของ Classroom ต้องระบุ
  3.4 ตัวเลือกการแปลเป็นภาษาท้องถิ่น: ภาษา _ควร_ อิงตามค่ากำหนดท้องถิ่นที่เบราว์เซอร์ตั้งค่าไว้ หากมี แนะนำ
  3.5 หากส่วนเสริมกำหนด maxPoints ส่วนเสริม _ต้อง_ ตั้งค่า pointsEarned ด้วยเมื่อนักเรียนส่งงานโดยใช้ข้อมูลเข้าสู่ระบบของครูที่จัดเก็บไว้ (แนะนำ) หรือเมื่อครูเปิดงานที่ส่งแล้วใน iframe ของการตรวจสอบงานของนักเรียน ต้องระบุ
  3.9 ส่วนเสริม _ควร_ เป็นไปตามหลักเกณฑ์ WCAG 2.1 ระดับ AA เกี่ยวกับการช่วยเหลือพิเศษ นักพัฒนาส่วนเสริมจะรายงานด้วยตนเองว่าข้อกำหนดนี้เป็นไปตามข้อกำหนด ณ เวลาที่ส่ง และส่วนเสริมยังคงเป็นไปตามข้อกำหนดต่อไปเมื่อมีการเปลี่ยนแปลงส่วนเสริมในอนาคต แนะนำ
  3.10 ข้อผิดพลาดใดๆ ที่ผู้ใช้พบ _ควร_ อ่านเข้าใจได้ แนะนำ
  3.11 หากมีการเปิด studentViewUri, teacherViewUri หรือ studentWorkViewUri จากงานหรือหลักสูตรที่คัดลอก ส่วนเสริม _ต้องไม่_ แสดงหน้าข้อผิดพลาดใน iframe ต้องระบุ
4.0 การค้นพบไฟล์แนบ
  4.1 หากไฟล์แนบต้องให้นักเรียนส่งงาน ไฟล์แนบ _ต้อง_ มี studentWorkReviewUri เพื่อให้ระบบถือว่าเป็นไฟล์แนบประเภทกิจกรรม ไม่ใช่ไฟล์แนบประเภทเนื้อหา ต้องระบุ
  4.2 iframe ของการค้นพบไฟล์แนบ _ต้อง_ มีอินเทอร์เฟซผู้ใช้ที่มีตัวเลือกต่อไปนี้อย่างน้อย 1 รายการ:
  • สร้างเนื้อหาใหม่เพื่อแนบ
  • เรียกดู เลือก และแนบจากคลังเนื้อหา
  • วิธีการแนบเนื้อหาจากเว็บไซต์หรือผลิตภัณฑ์อื่นๆ
ต้องระบุ
  4.3 ครู _ควร_ ค้นหาและเข้าถึงเนื้อหา/กิจกรรมทั้งหมดที่ครูเข้าถึงได้ แนะนำ
  4.4 ครู _ควร_ ดูตัวอย่างเนื้อหา/กิจกรรมได้ก่อนที่จะตัดสินใจแนบเนื้อหา/กิจกรรมดังกล่าวไปกับงาน แนะนำ
  4.5 หากครูต้องดำเนินการบางอย่างเพื่อสร้างเนื้อหา/กิจกรรมก่อนที่จะแนบได้ ครู _ควร_ ดำเนินการดังกล่าวใน iframe แนะนำ
5.0 มุมมองของนักเรียน
  5.1 เมื่อมีการเปิด studentViewUri ส่วนเสริม _ไม่ควร_ นำผู้ใช้ออกจาก iframe เพื่อทำงานให้เสร็จ
หากส่วนเสริมนำผู้ใช้ออกจาก iframe จะต้องมีข้อความหรือข้อบ่งชี้อื่นๆ ให้นักเรียนกลับไปยัง Classroom
แนะนำ
  5.2 หากกิจกรรมของส่วนเสริมปรากฏนอก iframe ควรมีตัวอย่างเกี่ยวกับงานใน iframe แนะนำ
  5.3 หากมี ปุ่มหรือลิงก์ในกิจกรรมที่มีป้ายกำกับว่าส่ง _ต้อง_ ทำให้เกิดคำขอ API เพื่อส่งงานของนักเรียนให้ครูตรวจ ต้องระบุ
6.0 มุมมองของครู
  6.1 ครู _ควร_ ดูสิ่งที่นักเรียนจะเห็นเมื่อทำตามงานได้ แนะนำ
7.0 การตรวจสอบงานของนักเรียน
  7.1 หากมีการเปิด studentWorkReviewUri ส่วนเสริม _ต้อง_ แสดงงานของนักเรียนคนดังกล่าวให้ครูตรวจภายใน iframe สื่อเสริมอาจลิงก์ไปยังภายนอก iframe ต้องระบุ
  7.2 ส่วนเสริม _ต้องไม่_ เปิดใช้การนำทางระหว่างนักเรียนในมุมมอง studentWorkReviewUri การนำทางระหว่างนักเรียน _ต้อง_ เกิดขึ้นใน UI ของ Classroom เท่านั้น ต้องระบุ
8.0 การสนับสนุน Classroom ในอุปกรณ์เคลื่อนที่
  8.1 เมื่อแอป Classroom ในอุปกรณ์เคลื่อนที่เปิด teacherViewUri, studentViewUri หรือ studentWorkReviewUri URL _ต้อง_ เปิดแอปที่มาพร้อมเครื่องสำหรับอุปกรณ์เคลื่อนที่หรือเว็บแอปสำหรับอุปกรณ์เคลื่อนที่ของพาร์ทเนอร์ และในทั้ง 2 กรณี URL จะต้องลิงก์โดยตรงไปยังมุมมองที่ถูกต้อง หากอุปกรณ์ไม่รองรับ ระบบ _ต้อง_ แสดงข้อความให้ผู้ใช้ทราบว่าเป็นอุปกรณ์ที่ไม่รองรับ และควรระบุอุปกรณ์ที่รองรับด้วย ต้องระบุ
  8.2 งานของนักเรียน _ควร_ ทำงานให้เสร็จในอุปกรณ์เคลื่อนที่ได้ แนะนำ
9.0 ฟีเจอร์เพิ่มเติม
  9.1 หากครูวางลิงก์ไปยังเนื้อหาของคุณเป็นไฟล์แนบลิงก์ได้ คุณ ควร_ อัปเกรดลิงก์เป็นไฟล์แนบของส่วนเสริม แนะนำ
  9.2 หากคุณใช้การผสานรวม CourseWork เพื่อสร้างงานจากภายนอก Classroom คุณ ควรสร้างไฟล์แนบของส่วนเสริมโดยค่าเริ่มต้น สำหรับลิงก์ทั้งหมดที่เข้ากันได้กับส่วนเสริม แนะนำ

บันทึกการเปลี่ยนแปลง

เวอร์ชัน 1.1 อัปเดตเมื่อวันที่ 5 ธ.ค. 2024
1.1, 1.3, 3.2, 3.10, 4.4, 5.2 เปลี่ยนจากต้องระบุเป็นแนะนำ
3.12 นำออกแล้ว
5.3 เปลี่ยนคำพูด การเปลี่ยนแปลงล่าสุดช่วยให้นักพัฒนาส่วนเสริมส่งงานของนักเรียนได้อย่างน่าเชื่อถือโดยใช้ API
เวอร์ชัน 1.0 อัปเดตเมื่อวันที่ 30 เม.ย. 2024
1.1 รวม 1.1 และ 1.2 เป็นข้อกำหนดเดียว
2.1 รวม 2.1 และ 2.5 เป็นข้อกำหนดเดียว
2.2 รวม 2.2, 2.3 และ 2.4 เป็นข้อกำหนดเดียว
3.5 รวม 3.5, 3.6 และ 3.7 เป็นข้อกำหนดเดียว
3.10 เพิ่มข้อกำหนดที่ว่าส่วนเสริมต้องไม่เข้าสู่สถานะที่ไม่สามารถเข้าใจได้หรือ กู้คืนไม่ได้
3.11, 3.12 รวม 5.5, 5.6, 6.3, 6.4, 7.5 และ 7.6 เป็นข้อกำหนดใหม่ 2 ข้อ
4.2 ขยายคำอธิบายเกี่ยวกับประสบการณ์การค้นพบไฟล์แนบที่ยอมรับได้
4.3 เปลี่ยนหมายเลขเป็น 4.2 และเปลี่ยนจากต้องระบุเป็น แนะนำ
4.4 เปลี่ยนหมายเลขเป็น 4.3
4.5 เปลี่ยนหมายเลขเป็น 4.4
5.2 เปลี่ยนหมายเลขเป็น 5.3
5.3 เปลี่ยนหมายเลขเป็น 5.2
9.1 เพิ่มคำแนะนำให้อัปเกรดลิงก์ที่วางเป็นไฟล์แนบ
9.2 เพิ่มคำแนะนำให้สร้างไฟล์แนบของส่วนเสริมโดยค่าเริ่มต้นเมื่อ สร้างงาน CourseWork โดยใช้โปรแกรม
2.6, 3.7, 3.8, 6.2, 7.3, 7.4 นำออกแล้ว
เวอร์ชัน 0.3 อัปเดตเมื่อวันที่ 22 พ.ย. 2022
2.3 แก้ไขคำแนะนำเกี่ยวกับคำแนะนำในการเข้าสู่ระบบ
2.4 รวมสถานการณ์ที่ต้องใช้ hd เป็น ที่จำเป็น
3.2 เปลี่ยนคำพูด "ระบุเส้นทาง"
5.5, 5.6, 6.3, 6.4, 7.5, 7.6 เพิ่มคำแนะนำที่ต้องทำและแนะนำสำหรับการคัดลอกหลักสูตรสำหรับ studentViewUri, teacherViewUri และ studentWorkReviewUri
เวอร์ชัน 0.2 อัปเดตเมื่อวันที่ 29 ต.ค. 2021
1.3 ปรับข้อความให้ชัดเจนยิ่งขึ้น
3.1 เพิ่ม "ส่วนเสริม _ต้อง_ เป็นไปตามหลักเกณฑ์ทั่วไปในการอนุมัติ GWM ที่ระบุไว้ในเว็บไซต์"
3.9 WCAG เปลี่ยนจากต้องระบุเป็นแนะนำ
5.1 เปลี่ยนจากต้องระบุเป็นแนะนำ
5.3 เพิ่ม "หากส่วนเสริมปรากฏนอก iframe จะต้องมีตัวอย่าง เกี่ยวกับงานใน iframe"
5.4 เพิ่ม "หากส่วนเสริมปรากฏนอก iframe ควรมีข้อความแจ้ง สำหรับนักเรียนให้กลับไปยัง Classroom"
8.1 เพิ่ม "หากอุปกรณ์ไม่รองรับ ระบบ _ต้อง_ แสดงข้อความให้ผู้ใช้ทราบว่าเป็นอุปกรณ์ที่ไม่รองรับ และควรระบุอุปกรณ์ที่รองรับด้วย"
8.2 งานของนักเรียนในอุปกรณ์เคลื่อนที่เปลี่ยนจากต้องระบุเป็นแนะนำ
เวอร์ชัน 0.1 อัปเดตเมื่อวันที่ 22 ก.ย. 2021
  รุ่นแรก