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)
  }
}
ช่อง
id

string

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

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

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

string

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

string

ส่วนของหลักสูตร เช่น "คาบที่ 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 ที่มีครูทุกคนในหลักสูตร กลุ่มนี้ไม่รับอีเมลและใช้ได้เฉพาะสิทธิ์เท่านั้น

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

string

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

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

object (DriveFolder)

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

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

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

object (CourseMaterialSet)

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

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

boolean

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

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

string

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

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

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

object (GradebookSettings)

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

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

CourseState

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

Enum
COURSE_STATE_UNSPECIFIED ไม่มีสถานะหลักสูตร ข้อความหลักสูตรที่แสดงจะไม่ใช้ค่านี้
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 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
ช่อง
ฟิลด์ Union material ข้อมูลวัสดุ material ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
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 แสดงคะแนนโดยรวมต่อครูในสมุดพกและโปรไฟล์นักเรียน ซ่อนจากนักเรียนในโปรไฟล์นักเรียน

เมธอด

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

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

delete

 ลบหลักสูตร

get

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

getGradingPeriodSettings

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

list

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

patch

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

update

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

updateGradingPeriodSettings

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