REST Resource: courses

Tài nguyên: Khoá học

Một khoá học trong Lớp học.

Biểu diễn dưới dạng 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
}
Trường
id

string

Giá trị nhận dạng của khoá học này do Lớp học chỉ định.

Khi creating a course, bạn có thể tuỳ ý đặt giá trị nhận dạng này thành alias string trong yêu cầu tạo bí danh tương ứng. id vẫn do Lớp học chỉ định và không thể cập nhật sau khi khoá học được tạo.

Việc chỉ định trường này trong mặt nạ cập nhật khoá học sẽ dẫn đến lỗi.
name

string

Tên của khoá học. Ví dụ: "Sinh học lớp 10". Bạn phải nhập tên. Tên này phải có từ 1 đến 750 ký tự và là một chuỗi UTF-8 hợp lệ.
section

string

Phần của khoá học. Ví dụ: "Tiết 2". Nếu được đặt, trường này phải là một chuỗi UTF-8 hợp lệ và không dài quá 2.800 ký tự.
descriptionHeading

string

Tiêu đề không bắt buộc cho nội dung mô tả. Ví dụ: "Chào mừng bạn đến với môn Sinh học lớp 10". Nếu được đặt, trường này phải là một chuỗi UTF-8 hợp lệ và không dài quá 3.600 ký tự.
description

string

Nội dung mô tả (không bắt buộc). Ví dụ: "Chúng ta sẽ tìm hiểu về cấu trúc của sinh vật sống thông qua sự kết hợp giữa sách giáo khoa, bài giảng của khách mời và bài tập thực hành. Hãy chuẩn bị tinh thần để đón nhận những điều thú vị!" Nếu được đặt, trường này phải là một chuỗi UTF-8 hợp lệ và không dài quá 30.000 ký tự.
room

string

Vị trí phòng (không bắt buộc). Ví dụ: "301". Nếu được đặt, trường này phải là một chuỗi UTF-8 hợp lệ và không dài quá 650 ký tự.
ownerId

string

Giá trị nhận dạng của chủ sở hữu khoá học.

Khi được chỉ định làm tham số của create course request, trường này là bắt buộc. Giá trị nhận dạng có thể là một trong những giá trị sau:

  • giá trị nhận dạng dạng số cho người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu

Bạn phải đặt giá trị này trong yêu cầu tạo. Quản trị viên cũng có thể chỉ định trường này trong patch course request để chuyển quyền sở hữu. Trong các bối cảnh khác, tệp này ở chế độ chỉ có thể đọc.
creationTime

string (Timestamp format)

Thời gian tạo khoá học. Việc chỉ định trường này trong mặt nạ cập nhật khoá học sẽ dẫn đến lỗi.

Chỉ có thể đọc.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Thời gian cập nhật gần đây nhất cho khoá học này. Việc chỉ định trường này trong mặt nạ cập nhật khoá học sẽ dẫn đến lỗi.

Chỉ có thể đọc.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
enrollmentCode

string

Mã đăng ký để sử dụng khi tham gia khoá học này. Việc chỉ định trường này trong mặt nạ cập nhật khoá học sẽ dẫn đến lỗi.

Chỉ có thể đọc.
courseState

enum (CourseState)

Trạng thái của khoá học. Nếu không được chỉ định, trạng thái mặc định là PROVISIONED.
teacherGroupEmail

string

Địa chỉ email của một nhóm trên Google Groups chứa tất cả giáo viên của khoá học. Nhóm này không chấp nhận email và chỉ có thể dùng để cấp quyền.

Chỉ có thể đọc.
courseGroupEmail

string

Địa chỉ email của một nhóm trên Google Groups chứa tất cả thành viên của khoá học. Nhóm này không chấp nhận email và chỉ có thể dùng để cấp quyền.

Chỉ có thể đọc.
teacherFolder

object (DriveFolder)

Thông tin về một Thư mục trên Drive được chia sẻ với tất cả giáo viên của khoá học.

Trường này sẽ chỉ được đặt cho giáo viên của khoá học và quản trị viên miền.

Chỉ có thể đọc.
courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

Bộ tài liệu xuất hiện trên trang "giới thiệu" của khoá học này.

Chỉ có thể đọc.
guardiansEnabled

boolean

Cho biết thông báo cho người giám hộ có được bật cho khoá học này hay không.

Chỉ có thể đọc.
calendarId

string

Mã lịch của một lịch mà tất cả thành viên của khoá học đều có thể xem, trong đó Lớp học thêm các sự kiện cho bài tập trong khoá học và thông báo trong khoá học.

Lịch cho một khoá học được tạo không đồng bộ khi khoá học được đặt thành CourseState.ACTIVE lần đầu tiên (tại thời điểm tạo hoặc khi khoá học được cập nhật thành ACTIVE thông qua giao diện người dùng hoặc API). Mã lịch sẽ không được điền cho đến khi quá trình tạo hoàn tất.

Chỉ có thể đọc.
gradebookSettings

object (GradebookSettings)

Chế độ cài đặt sổ điểm chỉ định cách tính tổng điểm của học viên cho khoá học và đối tượng có thể xem điểm.

Chỉ có thể đọc.
subject

string

Không bắt buộc. Môn học của khoá học.
learningStandardSettings

object (CourseLearningStandardSettings)

Không bắt buộc.

Các chế độ cài đặt liên quan đến tiêu chuẩn học tập có trong khoá học. Một khoá học có thể được chỉ định tối đa 20 bộ tiêu chuẩn học tập gốc.
levels

string

Không bắt buộc. Cấp độ của khoá học. Ví dụ: "Lớp 9", "Trung học cơ sở", "Lớp 4 – 5", "Mẫu giáo – Lớp 2", "3000". Nếu được đặt, trường này phải là một chuỗi UTF-8 hợp lệ và có ít hơn 1.000 ký tự.

Bạn chỉ có thể xoá trường này bằng phương thức courses.patch.

CourseState

Các trạng thái có thể có của một khoá học.

Enum
COURSE_STATE_UNSPECIFIED Không có trạng thái khoá học. Không có thông báo nào về khoá học được trả về sẽ sử dụng giá trị này.
ACTIVE Khoá học này đang hoạt động.
ARCHIVED Khoá học này đã được lưu trữ. Bạn không thể sửa đổi trạng thái này, ngoại trừ việc thay đổi sang một trạng thái khác.
PROVISIONED Khoá học đã được tạo nhưng chưa được kích hoạt. Giáo viên chính và quản trị viên miền có thể truy cập vào trạng thái này và có thể sửa đổi hoặc thay đổi trạng thái này thành ACTIVE hoặc DECLINED. Bạn chỉ có thể thay đổi một khoá học thành PROVISIONED nếu khoá học đó đang ở trạng thái DECLINED.
DECLINED Khoá học đã được tạo nhưng bị từ chối. Chủ sở hữu khoá học và quản trị viên miền có thể truy cập vào khoá học này, mặc dù khoá học sẽ không xuất hiện trong giao diện người dùng web. Bạn không thể sửa đổi khoá học, ngoại trừ việc thay đổi khoá học sang trạng thái PROVISIONED. Bạn chỉ có thể thay đổi một khoá học thành DECLINED nếu khoá học đó đang ở trạng thái PROVISIONED.
SUSPENDED Khoá học đã bị tạm ngưng. Bạn không thể sửa đổi khoá học và chỉ người dùng được xác định bằng ownerId mới có thể xem khoá học. Một khoá học có thể bị đặt ở trạng thái này nếu có khả năng vi phạm Điều khoản dịch vụ.

CourseMaterialSet

Một bộ tài liệu xuất hiện trên trang "Giới thiệu" của khoá học. Những tài liệu này có thể bao gồm đề cương môn học, lịch biểu hoặc thông tin cơ bản khác liên quan đến toàn bộ khoá học.

Biểu diễn dưới dạng JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
Trường
title

string

Tiêu đề cho nhóm này.
materials[]

object (CourseMaterial)

Tài liệu đính kèm với bộ này.

CourseMaterial

Tài liệu được đính kèm vào khoá học dưới dạng một phần của tập hợp tài liệu.

Biểu diễn dưới dạng JSON 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
Trường
Dữ liệu về vật liệu. Sau đây là danh sách các trường loại trừ lẫn nhau. Tối đa một trong các trường sẽ được đặt trong phản hồi:
driveFile

object (DriveFile)

Tệp đính kèm trên Google Drive.
youTubeVideo

object (YouTubeVideo)

Tệp đính kèm video trên YouTube.
form

object (Form)

Tệp đính kèm trên Google Biểu mẫu.
Kết thúc các trường loại trừ lẫn nhau.

GradebookSettings

Chế độ cài đặt sổ điểm cho một khoá học. Hãy xem bài viết này trên Trung tâm trợ giúp để biết thông tin chi tiết.

Biểu diễn dưới dạng JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
Trường
calculationType

enum (CalculationType)

Cho biết cách tính tổng điểm.
displaySetting

enum (DisplaySetting)

Cho biết ai có thể xem tổng điểm.
gradeCategories[]

object (GradeCategory)

Danh mục điểm có sẵn cho tài liệu môn học trong khoá học.

CalculationType

Các phương pháp có thể dùng để tính tổng điểm.

Enum
CALCULATION_TYPE_UNSPECIFIED Chưa chỉ định phương thức. Giá trị này không bao giờ được trả về.
TOTAL_POINTS Tổng điểm là tổng số điểm chia cho tổng số điểm tối đa, bất kể danh mục.
WEIGHTED_CATEGORIES Điểm tổng thể là điểm trung bình có trọng số theo danh mục.

DisplaySetting

Các chế độ cài đặt có thể dùng để hiển thị điểm tổng thể.

Enum
DISPLAY_SETTING_UNSPECIFIED Chưa chỉ định chế độ cài đặt. Giá trị này không bao giờ được trả về.
SHOW_OVERALL_GRADE Cho cả giáo viên và học viên xem tổng điểm trong sổ điểm và hồ sơ học viên.
HIDE_OVERALL_GRADE Không hiển thị tổng điểm trong sổ điểm hoặc hồ sơ học viên.
SHOW_TEACHERS_ONLY Cho giáo viên xem tổng điểm trong sổ điểm và hồ sơ học viên. Ẩn khỏi hồ sơ của học viên.

CourseLearningStandardSettings

Chế độ cài đặt tiêu chuẩn học tập cho một khoá học.

Biểu diễn dưới dạng JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
Trường
standardSets[]

object (LearningStandardSetRoot)

Bắt buộc. Bộ các tiêu chuẩn học tập gốc được áp dụng cho khoá học này.

LearningStandardSetRoot

Đại diện cho gốc của một bộ các tiêu chuẩn học tập đã chọn. Các mục con của mục gốc đã chọn sẽ xuất hiện khi bạn đặt mục tiêu học tập cho các mục trên trang Bảng tin trong giao diện người dùng của Lớp học.

Biểu diễn dưới dạng JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
Trường
caseGuid

object (CaseGuid)

Bắt buộc. GUID của Satchel Rosetta Exchange cho gốc của một bộ tiêu chuẩn học tập.
documentTitle

string

Chỉ có đầu ra. Tiêu đề tài liệu của gốc bộ tiêu chuẩn học tập.
standardTitle

string

Chỉ có đầu ra. Tiêu đề của gốc bộ tiêu chuẩn học tập.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

Chỉ có đầu ra. Trạng thái của bộ tiêu chuẩn học tập gốc. Sử dụng thuộc tính này để xác định xem gốc của bộ tiêu chuẩn học tập có bị xoá khỏi nguồn hay không.

Phương thức

checkAddOnCreationEligibility
(deprecated)

 Trả về việc người dùng có đủ điều kiện để tạo tệp đính kèm bằng tiện ích bổ sung trong một khoá học nhất định hay không.

checkGradingPeriodsSetupEligibility
(deprecated)

 Trả về thông tin cho biết liệu người dùng có đủ điều kiện để cập nhật GradingPeriodSettings trong một khoá học nhất định hay không.

create

 Tạo khoá học.

delete

 Xoá một khoá học.

get

 Trả về một khoá học.

getGradingPeriodSettings

 Trả về chế độ cài đặt giai đoạn chấm điểm trong một khoá học.

list

 Trả về danh sách các khoá học mà người dùng yêu cầu được phép xem, chỉ giới hạn ở những khoá học khớp với yêu cầu.

patch

 Cập nhật một hoặc nhiều trường trong một khoá học.

update

 Cập nhật khoá học.

updateGradingPeriodSettings

 Cập nhật chế độ cài đặt giai đoạn chấm điểm của một khoá học.