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 ในคำขอสร้างชื่อแทนที่เกี่ยวข้องได้ Classroom ยังคงมอบหมาย id อยู่และไม่สามารถอัปเดตได้หลังจากสร้างหลักสูตรแล้ว

การระบุช่องนี้ในมาสก์การอัปเดตหลักสูตรจะทำให้เกิดข้อผิดพลาด
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)

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

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

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

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
enrollmentCode

string

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

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

enum (CourseState)

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

string

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

อ่านอย่างเดียว
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.
}
ช่อง
ฟิลด์การรวม 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

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

create

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

delete

 ลบหลักสูตร

get

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

list

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

patch

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

update

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