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

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

checkGradingPeriodsSetupEligibility

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

create

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

delete

 ลบหลักสูตร

get

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

getGradingPeriodSettings

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

list

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

patch

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

update

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

updateGradingPeriodSettings

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