REST Resource: courses

แหล่งข้อมูล: หลักสูตร

หลักสูตรใน Classroom

การแสดง JSON 
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
ช่อง
id

string

ตัวระบุสำหรับหลักสูตรนี้ที่ Classroom กำหนดให้

เมื่อ creating a course คุณสามารถเลือกตั้งค่าตัวระบุนี้เป็น alias string ในคำขอเพื่อสร้างชื่อแทนที่เกี่ยวข้องได้ id ยังคงกำหนดโดย Classroom และไม่สามารถอัปเดตได้หลังจากสร้างหลักสูตรแล้ว

การระบุช่องนี้ในมาสก์การอัปเดตหลักสูตรจะทำให้เกิดข้อผิดพลาด
name

string

ชื่อของหลักสูตร เช่น "ชีววิทยาเกรด 10" ต้องระบุชื่อ โดยต้องมีอักขระระหว่าง 1 ถึง 750 ตัวและเป็นสตริง UTF-8 ที่ถูกต้อง
section

string

ส่วนของหลักสูตร เช่น "Period 2" หากตั้งค่าไว้ ช่องนี้ต้องเป็นสตริง UTF-8 ที่ถูกต้องและมีความยาวไม่เกิน 2, 800 อักขระ
descriptionHeading

string

ส่วนหัวที่ไม่บังคับสำหรับคำอธิบาย เช่น "ยินดีต้อนรับสู่ชั้นเรียนชีววิทยาเกรด 10" หากตั้งค่าไว้ ช่องนี้ต้องเป็นสตริง UTF-8 ที่ถูกต้องและมีความยาวไม่เกิน 3, 600 อักขระ
description

string

คำอธิบายเพิ่มเติม เช่น "เราจะเรียนรู้เกี่ยวกับโครงสร้างของสิ่งมีชีวิตจากหนังสือเรียน การบรรยายจากวิทยากรรับเชิญ และการทำงานในห้องปฏิบัติการ เตรียมตัวตื่นเต้นได้เลย" หากตั้งค่าไว้ ช่องนี้ต้องเป็นสตริง UTF-8 ที่ถูกต้องและมีความยาวไม่เกิน 30,000 อักขระ
room

string

ตำแหน่งห้อง (ไม่บังคับ) เช่น "301" หากตั้งค่าไว้ ช่องนี้ต้องเป็นสตริง UTF-8 ที่ถูกต้องและมีความยาวไม่เกิน 650 อักขระ
ownerId

string

ตัวระบุของเจ้าของหลักสูตร

เมื่อระบุเป็นพารามิเตอร์ของ create course request ต้องระบุช่องนี้ ตัวระบุอาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

  • ตัวระบุที่เป็นตัวเลขสำหรับผู้ใช้
  • อีเมลของผู้ใช้
  • สตริงตามตัวอักษร "me" ซึ่งระบุผู้ใช้ที่ส่งคำขอ

ต้องตั้งค่านี้ในคำขอสร้าง นอกจากนี้ ผู้ดูแลระบบยังระบุช่องนี้ใน patch course request เพื่อโอนการเป็นเจ้าของได้ด้วย ในบริบทอื่นๆ จะเป็นแบบอ่านอย่างเดียว
creationTime

string (Timestamp format)

เวลาที่สร้างหลักสูตร การระบุช่องนี้ในมาสก์การอัปเดตหลักสูตรจะทำให้เกิดข้อผิดพลาด

อ่านอย่างเดียว

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

เวลาที่อัปเดตหลักสูตรนี้ล่าสุด การระบุช่องนี้ในมาสก์การอัปเดตหลักสูตรจะทำให้เกิดข้อผิดพลาด

อ่านอย่างเดียว

ใช้ RFC 3339 โดยเอาต์พุตที่สร้างขึ้นจะได้รับการแปลงเป็นรูปแบบ Z เสมอ และใช้ตัวเลขเศษส่วน 0, 3, 6 หรือ 9 หลัก นอกจากนี้ ระบบยังยอมรับออฟเซ็ตอื่นๆ นอกเหนือจาก "Z" ด้วย เช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
enrollmentCode

string

รหัสการลงทะเบียนที่จะใช้เมื่อเข้าร่วมหลักสูตรนี้ การระบุช่องนี้ในมาสก์การอัปเดตหลักสูตรจะทำให้เกิดข้อผิดพลาด

อ่านอย่างเดียว
courseState

enum (CourseState)

สถานะของหลักสูตร หากไม่ได้ระบุ สถานะเริ่มต้นจะเป็น PROVISIONED
teacherGroupEmail

string

อีเมลของ Google Group ที่มีครูทุกคนในหลักสูตร กลุ่มนี้ไม่รับอีเมลและใช้ได้เฉพาะสำหรับการให้สิทธิ์เท่านั้น

อ่านอย่างเดียว
courseGroupEmail

string

อีเมลของ Google Group ที่มีสมาชิกทั้งหมดของหลักสูตร กลุ่มนี้ไม่รับอีเมลและใช้ได้เฉพาะสำหรับการให้สิทธิ์เท่านั้น

อ่านอย่างเดียว
teacherFolder

object (DriveFolder)

ข้อมูลเกี่ยวกับโฟลเดอร์ไดรฟ์ที่แชร์กับครูทุกคนในหลักสูตร

ระบบจะตั้งค่าช่องนี้สำหรับครูของหลักสูตรและผู้ดูแลระบบโดเมนเท่านั้น

อ่านอย่างเดียว
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

ชุดสื่อการสอนที่ปรากฏในหน้า "เกี่ยวกับ" ของหลักสูตรนี้

อ่านอย่างเดียว
guardiansEnabled

boolean

ระบุว่ามีการเปิดใช้การแจ้งเตือนสำหรับผู้ปกครองในหลักสูตรนี้หรือไม่

อ่านอย่างเดียว
calendarId

string

รหัสปฏิทินสำหรับปฏิทินที่สมาชิกทุกคนในหลักสูตรสามารถดูได้ ซึ่ง Classroom จะเพิ่มกิจกรรมสำหรับงานของหลักสูตรและประกาศในหลักสูตรลงในปฏิทินนี้

ระบบจะสร้างปฏิทินสำหรับรายวิชาแบบอะซิงโครนัสเมื่อตั้งค่ารายวิชาเป็น CourseState.ACTIVE เป็นครั้งแรก (เมื่อสร้างหรือเมื่ออัปเดตเป็น ACTIVE ผ่าน UI หรือ API) รหัสปฏิทินจะไม่แสดงจนกว่ากระบวนการสร้างจะเสร็จสมบูรณ์

อ่านอย่างเดียว
gradebookSettings

object (GradebookSettings)

การตั้งค่าสมุดพกที่ระบุวิธีคำนวณคะแนนโดยรวมของนักเรียน/นักศึกษาสำหรับหลักสูตรและผู้ที่จะเห็นคะแนนดังกล่าว

อ่านอย่างเดียว
subject

string

ไม่บังคับ หัวเรื่องของหลักสูตร
learningStandardSettings

object (CourseLearningStandardSettings)

ไม่บังคับ

การตั้งค่าที่เกี่ยวข้องกับมาตรฐานการเรียนรู้ที่ใช้ได้ในหลักสูตร หลักสูตรหนึ่งๆ สามารถกำหนดรูทของชุดมาตรฐานการเรียนรู้ได้สูงสุด 20 รายการ
levels

string

ไม่บังคับ ระดับของหลักสูตร ตัวอย่าง: "มัธยมศึกษาปีที่ 3", "มัธยมศึกษาตอนต้น", "ป. 4 - ป. 5", "อนุบาล - ป. 2", "3000" หากตั้งค่าไว้ ช่องนี้ต้องเป็นสตริง UTF-8 ที่ถูกต้องและมีอักขระไม่เกิน 1, 000 ตัว

คุณล้างข้อมูลในช่องนี้ได้โดยใช้วิธี courses.patch เท่านั้น

CourseState

สถานะที่เป็นไปได้ของหลักสูตร

Enum
COURSE_STATE_UNSPECIFIED ไม่มีสถานะหลักสูตร ข้อความ Course ที่แสดงผลจะไม่มีการใช้ค่านี้
ACTIVE หลักสูตรทำงานอยู่
ARCHIVED เก็บหลักสูตรแล้ว คุณจะแก้ไขไม่ได้ ยกเว้นการเปลี่ยนเป็นสถานะอื่น
PROVISIONED สร้างหลักสูตรแล้ว แต่ยังไม่ได้เปิดใช้งาน ครูผู้สอนหลักและผู้ดูแลระบบโดเมนจะเข้าถึงสถานะนี้ได้ และอาจแก้ไขหรือเปลี่ยนสถานะเป็น ACTIVE หรือ DECLINED หลักสูตรจะเปลี่ยนเป็น PROVISIONED ได้ก็ต่อเมื่ออยู่ในสถานะ DECLINED เท่านั้น
DECLINED สร้างหลักสูตรแล้ว แต่ถูกปฏิเสธ เจ้าของหลักสูตรและผู้ดูแลระบบโดเมนจะเข้าถึงได้ แม้ว่าจะไม่แสดงใน UI ของเว็บก็ตาม คุณไม่สามารถแก้ไขหลักสูตรได้ ยกเว้นการเปลี่ยนเป็นสถานะ PROVISIONED หลักสูตรจะเปลี่ยนเป็น DECLINED ได้ก็ต่อเมื่ออยู่ในสถานะ PROVISIONED เท่านั้น
SUSPENDED หลักสูตรถูกระงับแล้ว คุณไม่สามารถแก้ไขหลักสูตร และมีเพียงผู้ใช้ที่ระบุโดย ownerId เท่านั้นที่ดูหลักสูตรได้ ระบบอาจกำหนดให้หลักสูตรอยู่ในสถานะนี้หากอาจละเมิดข้อกำหนดในการให้บริการ

CourseMaterialSet

ชุดสื่อการเรียนการสอนที่ปรากฏในหน้า "เกี่ยวกับ" ของหลักสูตร เอกสารเหล่านี้อาจรวมถึงประมวลรายวิชา กำหนดการ หรือข้อมูลเบื้องหลังอื่นๆ ที่เกี่ยวข้องกับหลักสูตรโดยรวม

การแสดง JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
ช่อง
title

string

ชื่อสำหรับชุดนี้
materials[]

object (CourseMaterial)

สื่อการเรียนการสอนที่แนบมากับชุดนี้

CourseMaterial

สื่อการสอนที่แนบมากับหลักสูตรเป็นส่วนหนึ่งของชุดสื่อการสอน

การแสดง JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
ช่อง
ข้อมูลวัสดุ ต่อไปนี้คือรายการช่องที่แยกกันโดยสิ้นเชิง ระบบจะตั้งค่าช่องอย่างน้อย 1 ช่องในการตอบกลับ ดังนี้
driveFile

object (DriveFile)

ไฟล์แนบ Google ไดรฟ์
youTubeVideo

object (YouTubeVideo)

ไฟล์แนบวิดีโอ YouTube
form

object (Form)

ไฟล์แนบ Google ฟอร์ม
สิ้นสุดฟิลด์ที่แยกกัน

GradebookSettings

การตั้งค่าสมุดพกสำหรับหลักสูตร ดูรายละเอียดได้ที่บทความในศูนย์ช่วยเหลือ

การแสดง JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
ช่อง
calculationType

enum (CalculationType)

ระบุวิธีคำนวณคะแนนรวม
displaySetting

enum (DisplaySetting)

ระบุผู้ที่ดูคะแนนโดยรวมได้
gradeCategories[]

object (GradeCategory)

หมวดหมู่คะแนนที่ใช้ได้กับงานของหลักสูตรในหลักสูตร

CalculationType

วิธีการคำนวณคะแนนรวมที่เป็นไปได้

Enum
CALCULATION_TYPE_UNSPECIFIED ไม่ได้ระบุวิธีการ ระบบจะไม่แสดงผลลัพธ์นี้
TOTAL_POINTS คะแนนโดยรวมคือผลรวมของคะแนนหารด้วยผลรวมของคะแนนเต็ม โดยไม่คำนึงถึงหมวดหมู่
WEIGHTED_CATEGORIES คะแนนรวมคือค่าเฉลี่ยถ่วงน้ำหนักตามหมวดหมู่

DisplaySetting

การตั้งค่าที่เป็นไปได้สำหรับการแสดงคะแนนรวม

Enum
DISPLAY_SETTING_UNSPECIFIED ไม่ได้ระบุการตั้งค่า ระบบจะไม่แสดงผลลัพธ์นี้
SHOW_OVERALL_GRADE แสดงคะแนนโดยรวมในสมุดพกและโปรไฟล์ของนักเรียนให้ทั้งครูและนักเรียนเห็น
HIDE_OVERALL_GRADE ไม่แสดงคะแนนโดยรวมในสมุดพกหรือโปรไฟล์ของนักเรียน
SHOW_TEACHERS_ONLY แสดงคะแนนโดยรวมให้ครูเห็นในสมุดพกและโปรไฟล์ของนักเรียน ซ่อนจากนักเรียนในโปรไฟล์นักเรียน

CourseLearningStandardSettings

การตั้งค่าชุดมาตรฐานการเรียนรู้สำหรับหลักสูตร

การแสดง JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
ช่อง
standardSets[]

object (LearningStandardSetRoot)

ต้องระบุ ชุดรากฐานมาตรฐานการเรียนรู้ที่ใช้กับหลักสูตรนี้

LearningStandardSetRoot

แสดงรากของชุดมาตรฐานการเรียนรู้ที่เลือก ระบบจะแสดงรายการย่อยของรูทที่เลือกเมื่อตั้งค่าเป้าหมายการเรียนรู้ในรายการสตรีมใน UI ของ Classroom

การแสดง JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
ช่อง
caseGuid

object (CaseGuid)

ต้องระบุ GUID ของ Satchel Rosetta Exchange สำหรับรูทของชุดมาตรฐานการเรียนรู้
documentTitle

string

เอาต์พุตเท่านั้น ชื่อเอกสารของรูทชุดมาตรฐานการเรียนรู้
standardTitle

string

เอาต์พุตเท่านั้น ชื่อของรูทชุดมาตรฐานการเรียนรู้
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

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

เมธอด

checkAddOnCreationEligibility
(deprecated)

 แสดงผลว่าผู้ใช้มีสิทธิ์สร้างไฟล์แนบของส่วนเสริมในหลักสูตรที่ระบุหรือไม่

checkGradingPeriodsSetupEligibility
(deprecated)

 แสดงผลว่าผู้ใช้มีสิทธิ์อัปเดต GradingPeriodSettings ในหลักสูตรที่ระบุหรือไม่

create

 สร้างหลักสูตร

delete

 ลบหลักสูตร

get

 แสดงผลหลักสูตร

getGradingPeriodSettings

 แสดงผลการตั้งค่าระยะเวลาการให้คะแนนในหลักสูตร

list

 แสดงรายการหลักสูตรที่ผู้ใช้ที่ส่งคำขอได้รับอนุญาตให้ดู โดยจำกัดเฉพาะหลักสูตรที่ตรงกับคำขอ

patch

 อัปเดตช่องอย่างน้อย 1 ช่องในหลักสูตร

update

 อัปเดตหลักสูตร

updateGradingPeriodSettings

 อัปเดตการตั้งค่าระยะเวลาการให้คะแนนของหลักสูตร