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)

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

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

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

อ่านอย่างเดียว
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
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

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

delete

 ลบหลักสูตร

get

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

getGradingPeriodSettings

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

list

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

patch

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

update

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

updateGradingPeriodSettings

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