ภาพรวม

Classroom API มีอินเทอร์เฟซ RESTful ให้คุณจัดการหลักสูตรและรายชื่อใน Google Classroom นอกจากนี้ ปุ่มแชร์ของ Classroom อนุญาตให้นักพัฒนาแอปและเจ้าของเนื้อหาเปิดใช้การแชร์เนื้อหาของตนไปยัง Classroom ได้ด้วย

ใครใช้ API ได้บ้าง

ผู้ดูแลระบบโดเมน G Suite for Education สามารถใช้ API เพื่อจัดสรรหลักสูตรแบบเป็นโปรแกรมในนามของครู ซิงค์ระบบข้อมูลของนักเรียนกับ Classroom และมองเห็นข้อมูลพื้นฐานในชั้นเรียนต่างๆ ที่เรียนในโดเมนของคุณ

นักพัฒนาแอปพลิเคชันสามารถใช้ Classroom API เพื่อผสานรวมแอปกับ Classroom ได้ แอปเหล่านี้ต้องใช้ OAuth 2.0 เพื่อขอสิทธิ์ดูชั้นเรียนและบัญชีรายชื่อจากครู ผู้ดูแลระบบจะจํากัดได้ว่าจะให้ครูและนักเรียนในโดเมนของตนให้สิทธิ์แอปเข้าถึงข้อมูล Google Classroom ได้หรือไม่

เจ้าของเว็บไซต์และนักพัฒนาแอปสามารถใช้ปุ่มแชร์ของ Classroom เพื่อให้นักเรียนและครูแชร์เนื้อหากลับไปที่ Classroom ได้

การผสานรวมปุ่มแชร์ของ API และ Classroom ทั้งหมดควรเป็นไปตามหลักเกณฑ์ของแบรนด์ Classroom

ภาพรวมของ API

Classroom API ประกอบด้วยเอนทิตีหลายประเภทที่สอดคล้องกับชั้นเรียน ครู และนักเรียนในอินเทอร์เฟซของ Classroom เอนทิตีเหล่านี้บางรายการมีพร็อพเพอร์ตี้เพิ่มเติมเฉพาะสําหรับ API นอกเหนือจากที่มีอยู่ใน Classroom ประเภทเอนทิตีหลักมีดังนี้

ดูข้อมูลโดยละเอียดเกี่ยวกับทรัพยากรและเมธอดของ API ได้ที่ข้อมูลอ้างอิงของ Classroom API

ข้อมูลเมตาและชื่อแทนของหลักสูตร

หลักสูตรหมายถึงชั้นเรียน เช่น "M คณิตศาสตร์ของ #Smith สมัยที่ 4," และครูที่มอบหมาย บัญชีรายชื่อนักเรียน และข้อมูลเมตา ระบบจะระบุแต่ละหลักสูตรด้วยรหัสที่ไม่ซ้ํากันที่เซิร์ฟเวอร์กําหนด ทรัพยากรหลักสูตรจะสรุปข้อมูลเมตาทั้งหมดเกี่ยวกับหลักสูตรไว้โดยเฉพาะ เช่น ชื่อ คําอธิบาย สถานที่ และเวลา บัญชีรายชื่อหลักสูตรจะจัดการผ่านทรัพยากรของนักเรียน ครู และคําเชิญและวิธีการ

ชื่อแทนคือตัวระบุทางเลือกสําหรับชั้นเรียนที่อาจเชื่อมโยงกับหลักสูตรและใช้แทนรหัสที่ไม่ซ้ํากัน ชื่อแทนแต่ละรายการจะอยู่ในเนมสเปซที่จํากัดบุคคลที่สร้างและดูได้ รองรับเนมสเปซ 2 รายการต่อไปนี้

  • โดเมน: เนมสเปซของโดเมนมีประโยชน์สําหรับการสร้างชื่อแทนที่ผู้ใช้ทุกคนต้องมีสิทธิ์เข้าถึง แต่ไม่ได้เจาะจงเฉพาะกับโปรแกรมใดโปรแกรมหนึ่ง ตัวอย่างเช่น ควรสร้างข้อมูลสํารองของหลักสูตร เช่น MATH 127 และ COMSCI 127 ในเนมสเปซของโดเมน ชื่อแทนโดเมนในเนมสเปซของโดเมนอาจสร้างได้โดยผู้ดูแลระบบโดเมนเท่านั้น แต่ผู้ใช้ทุกคนในโดเมนจะมองเห็น
  • โปรเจ็กต์นักพัฒนาซอฟต์แวร์: เนมสเปซของโปรเจ็กต์นักพัฒนาซอฟต์แวร์มีประโยชน์สําหรับการจัดการชื่อแทนเฉพาะสําหรับแอปพลิเคชัน ตัวอย่างเช่น แอปพลิเคชันที่ใช้ตัวระบุทางเลือกสําหรับหลักสูตรสามารถสร้างชื่อแทนเพื่อแมปตัวระบุกับหลักสูตรของ Classroom ชื่อแทนที่สร้างในเนมสเปซนี้จะผูกกับคอนโซล Google API ที่เจาะจง ผู้ใช้แอปพลิเคชันทุกคนสามารถสร้างและดูชื่อแทนในเนมสเปซของโครงการนักพัฒนาซอฟต์แวร์ของแอปพลิเคชันนั้นได้

ดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการข้อมูลเมตาและชื่อแทนของหลักสูตรได้ที่จัดการหลักสูตร

บัญชีรายชื่อและผู้ใช้หลักสูตร

นักเรียนและครูเป็นการจับคู่ที่เฉพาะเจาะจงระหว่างโปรไฟล์ผู้ใช้และหลักสูตร ซึ่งแสดงถึงบทบาทของผู้ใช้รายนั้นในหลักสูตร การกําหนดนักเรียนและครูนั้นไม่ใช่แบบทั่วโลก: สามารถกําหนดผู้ใช้เป็นครูสําหรับหลักสูตรหนึ่งและนักเรียนในอีกหลักสูตรหนึ่ง การระบุสถานะ &ยกเ

นักเรียน/นักศึกษา
แหล่งข้อมูลสําหรับนักเรียนคือผู้ใช้ที่ลงทะเบียนเป็นนักเรียน/นักศึกษาในหลักสูตรที่เฉพาะเจาะจง นักเรียนดูรายละเอียดของหลักสูตรและครูของหลักสูตรนั้นได้
ครู
แหล่งข้อมูลของครูแสดงถึงผู้ใช้ที่สอนหลักสูตรเฉพาะ ครูได้รับอนุญาตให้ดูและเปลี่ยนรายละเอียดหลักสูตร ดูครูและนักเรียน รวมทั้งจัดการครูและนักเรียนเพิ่มเติม

คําเชิญและวิธีการที่เกี่ยวข้องจะมอบวิธีที่สะดวกในการเพิ่มนักเรียนและครูในหลักสูตร ซึ่งการสร้างคําเชิญจะทําให้ผู้ใช้เลือกได้ว่าจะเข้าร่วมหลักสูตรหรือไม่ แทนที่จะต้องเพิ่มโดยตรงผ่านแหล่งข้อมูลของครูและนักเรียน

UserProfiles แสดงการแมปกับโปรไฟล์โดเมนของผู้ใช้ตามที่กําหนดโดยรหัสที่ไม่ซ้ํากันหรืออีเมลของผู้ใช้ที่แสดงผลโดย Google Admin SDK ผู้ใช้ปัจจุบันอาจอ้างอิงรหัสของตนเองได้โดยใช้วิดีโอสั้นของ "me"

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการบัญชีรายชื่อที่จัดการครูและนักเรียน

การส่งงานของนักเรียนและหลักสูตร

รายการ CourseWork แสดงถึงงานเดียวที่มอบหมายให้กับกลุ่มนักเรียนในหลักสูตร ซึ่งจะมีรายละเอียดต่างๆ เช่น คําอธิบาย วันที่ครบกําหนด และ เนื้อหา ตลอดจนข้อมูลเมตา เช่น เวลาที่สร้าง วัสดุมีทั้งชื่อ ภาพขนาดย่อ และ URL รวมถึงตัวระบุที่ใช้กับ API ที่เหมาะสมได้ (เช่น ไดรฟ์, YouTube)

รายการ CourseWork จะอธิบายงานประเภทใดประเภทหนึ่งต่อไปนี้

  • งานที่นักเรียนทําได้โดยการส่งใบงานหรือไฟล์แนบอื่นๆ
  • คําถามที่ต้องการคําตอบสั้นๆ หรือคําถามแบบหลายตัวเลือก

งานของนักเรียนสําหรับรายการใน CourseWork จะแสดงเป็น StudentSubmission ซึ่งประกอบด้วยการตอบกลับและข้อมูลเมตาเพิ่มเติม เช่น รัฐและระดับชั้นที่ได้รับมอบหมาย

เนื้อหาของ StudentSubmission จะขึ้นอยู่กับประเภทของรายการหลักสูตรที่เกี่ยวข้อง ดังนี้

  • เวิร์กชีตและไฟล์แนบที่ส่งมาเพื่อการมอบหมาย ได้แก่ ชื่อ ภาพขนาดย่อ และ URL รวมถึงตัวระบุที่ใช้ร่วมกับ API ที่เหมาะสมได้ เช่น ไดรฟ์หรือ YouTube
  • การตอบคําถามสั้นๆ หรือคําถามแบบหลายตัวเลือก

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการจัดการการบ้านและรายงานและงานของนักเรียนที่หัวข้อจัดการงานของชั้นเรียน

เริ่มต้นใช้งาน

หากต้องการตั้งค่าสภาพแวดล้อมและเริ่มต้นใช้งาน API ทันที ให้ลองใช้คู่มือเริ่มใช้งานฉบับย่อแบบใดแบบหนึ่งต่อไปนี้

นอกจากนี้ คุณยังสํารวจเอกสารอ้างอิง API ได้ด้วย