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

เวอร์ชัน 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 ผู้ใช้ที่เป็นครูต้องลงชื่อเข้าใช้ส่วนเสริมโดยใช้ SSO ของ Google
หากระบบขอให้ผู้ใช้ที่เป็นนักเรียน/นักศึกษาลงชื่อเข้าใช้ส่วนเสริม ผู้ใช้จะต้องลงชื่อเข้าใช้โดยใช้ SSO ของ Google
ต้องระบุ
  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 ผู้ใช้ต้องทำตามเส้นทางโดยใช้เวิร์กโฟลว์ของส่วนเสริมเท่านั้น และไม่เปลี่ยนไปใช้เวิร์กโฟลว์ของงานในชั้นเรียนหรือใช้ปุ่มแชร์ใน 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 กรณีจะต้องใช้ Deep Link ไปยังมุมมองที่ถูกต้อง หากอุปกรณ์ไม่รองรับ ระบบจะต้องแสดงข้อความแก่ผู้ใช้เพื่อแจ้งให้ทราบว่าเป็นอุปกรณ์ที่ไม่รองรับ และควรแจ้งให้ทราบด้วยว่าอุปกรณ์ใดบ้างที่รองรับ ต้องระบุ
  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 นอกจากนี้ ยังเปลี่ยนจาก REQUIRED เป็น RECOMMENDED ด้วย
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 ซึ่งอยู่ในเว็บไซต์ของ GWM"
3.9 WCAG เปลี่ยนจาก "ต้องระบุ" เป็น "แนะนำ"
5.1 เปลี่ยนจาก "ต้องระบุ" เป็น "แนะนำ"
5.3 เพิ่มข้อความ "หากส่วนเสริมปรากฏนอก iframe จะต้องมีตัวอย่าง เกี่ยวกับงานใน iframe"
5.4 เพิ่มข้อความ "หากส่วนเสริมปรากฏขึ้นนอก iframe ควรมีข้อความแจ้ง ให้นักเรียนกลับไปที่ Classroom"
8.1 เพิ่มข้อความ "หากอุปกรณ์ไม่รองรับ ระบบจะต้องแสดงข้อความแก่ผู้ใช้เพื่อแจ้งให้ทราบว่าเป็นอุปกรณ์ที่ไม่รองรับ และควรแจ้งให้ทราบว่าอุปกรณ์ใดบ้างที่รองรับ"
8.2 งานของนักเรียนในอุปกรณ์เคลื่อนที่เปลี่ยนจาก "ต้องระบุ" เป็น "แนะนำ"
เวอร์ชัน 0.1 อัปเดตเมื่อวันที่ 22 ก.ย. 2021
  รุ่นแรก