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

เวอร์ชัน 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 ผู้ใช้ต้องทำตามขั้นตอนโดยใช้เวิร์กโฟลว์ของส่วนเสริมจนเสร็จสมบูรณ์เท่านั้น และต้องไม่เปลี่ยนไปใช้เวิร์กโฟลว์ของ Coursework หรือใช้ปุ่มแชร์ของ Classroom ต้องระบุ
  3.4 ตัวเลือกการแปล: ภาษาควรอิงตามค่ากำหนดในท้องถิ่นที่เบราว์เซอร์ตั้งไว้ (หากมี) แนะนำ
  3.5 หากส่วนเสริมกำหนด maxPoints ไว้ จะต้องตั้งค่า pointsEarned ด้วยเมื่อนักเรียนส่งงานโดยใช้ข้อมูลเข้าสู่ระบบของครูที่จัดเก็บไว้ (แนะนำ) หรือเมื่อครูเปิดงานที่ส่งใน iframe ของการตรวจสอบงานของนักเรียน ต้องระบุ
  3.9 ส่วนเสริมควรเป็นไปตามหลักเกณฑ์การช่วยเหลือพิเศษระดับ AA ของ WCAG 2.1 นักพัฒนาส่วนเสริมจะรายงานด้วยตนเองว่าเป็นไปตามข้อกำหนดนี้ ณ เวลาที่ส่ง และส่วนเสริมยังคงเป็นไปตามการเปลี่ยนแปลงในอนาคตของส่วนเสริม แนะนำ
  3.10 ข้อผิดพลาดที่ผู้ใช้พบควรเป็นข้อผิดพลาดที่มนุษย์อ่านได้ แนะนำ
  3.11 หากเปิด studentViewUri, teacherViewUri หรือ studentWorkViewUri จากงานที่คัดลอกหรือหลักสูตรที่คัดลอก ส่วนเสริมต้องไม่แสดงหน้าข้อผิดพลาดใน iframe ต้องระบุ
4.0 การค้นพบไฟล์แนบ
  4.1 หากไฟล์แนบกำหนดให้นักเรียนส่งงาน ไฟล์แนบนั้นต้องมี studentWorkReviewUri เพื่อให้ระบบถือว่าเป็นไฟล์แนบประเภทกิจกรรม ไม่ใช่ไฟล์แนบประเภทเนื้อหา ต้องระบุ
  4.2 iframe ของเครื่องมือค้นหาไฟล์แนบต้องมีอินเทอร์เฟซผู้ใช้ที่ให้บริการอย่างใดอย่างหนึ่งต่อไปนี้เป็นอย่างน้อย
  • สร้างเนื้อหาใหม่เพื่อแนบ
  • เรียกดู เลือก และแนบจากคลังเนื้อหา
  • วิธีแนบเนื้อหาจากเว็บไซต์หรือผลิตภัณฑ์อื่นๆ
ต้องระบุ
  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 จะต้องเปิดแอปเนทีฟบนอุปกรณ์เคลื่อนที่หรือเว็บแอปบนอุปกรณ์เคลื่อนที่ของพาร์ทเนอร์ และไม่ว่าจะในกรณีใดก็ตาม URL จะต้องทํา 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 และเปลี่ยนจาก "ต้องระบุ" เป็น "แนะนำ" ด้วย
4.4 เปลี่ยนหมายเลขจากเดิม 4.3
4.5 เปลี่ยนหมายเลขจากเดิม 4.4
5.2 เปลี่ยนหมายเลขแล้ว จากเดิมคือ 5.3
5.3 เปลี่ยนหมายเลขแล้ว จากเดิมคือ 5.2
9.1 เพิ่มคําแนะนําให้อัปเกรดลิงก์ที่วางเป็นไฟล์แนบ
9.2 เพิ่มคําแนะนําให้สร้างไฟล์แนบของส่วนเสริมโดยค่าเริ่มต้นเมื่อสร้างงานในหลักสูตรด้วยโปรแกรม
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
  การเผยแพร่ครั้งแรก