REST Resource: courses

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

Một khoá học trên 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)
  }
}
Trường
id

string

Mã nhận dạng cho 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 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.
name

string

Tên khoá học. Ví dụ: "Sinh học lớp 10". Tên là bắt buộc. Chuỗi 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ụ: "Kỳ 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á 2800 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 lớp Sinh học 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á 3600 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 các sinh vật sống thông qua sách giáo khoa, bài giảng của khách mời và bài tập thực hành. Bạn sẽ rất hào hứng đấy!" 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ố của 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 ngữ cảnh khác, thuộc tính 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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Thời điểm cập nhật gần đây nhất của 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.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".
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 chỉ định, trạng thái mặc định sẽ là PROVISIONED.
teacherGroupEmail

string

Địa chỉ email của một nhóm Google 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 cho quyền.

Chỉ có thể đọc.
courseGroupEmail

string

Địa chỉ email của một nhóm Google 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 cho quyền.

Chỉ có thể đọc.
teacherFolder

object (DriveFolder)

Thông tin về một Thư mục 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)

Các 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 tính năng 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 trong khoá học đều có thể xem. Lớp học sẽ thêm các sự kiện về bài tập và thông báo trong khoá học vào lịch này.

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 đượ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à người sẽ thấy tổng điểm đó.

Chỉ đọc

CourseState

Các trạng thái có thể xảy ra với 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 đ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 trạng thái này thành 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 chế độ này. Họ có thể sửa đổi hoặc thay đổi chế độ này thành trạng thái ACTIVE hoặc DECLINED. Bạn chỉ có thể thay đổi trạng thái của 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 trang này, mặc dù trang này 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 thành trạng thái PROVISIONED. Bạn chỉ có thể thay đổi trạng thái của một khoá học thành DECLINED nếu khoá học đó đang ở trạng thái PROVISIONED.
SUSPENDED Khoá học này đã bị tạm ngưng. Bạn không thể sửa đổi khoá học và chỉ người dùng do ownerId xác định mới có thể xem khoá học. Một khoá học có thể được đặ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 giáo trình, lịch trình 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 đề của bộ này.
materials[]

object (CourseMaterial)

Tài liệu đính kèm vào bộ bài tập này.

CourseMaterial

Một tài liệu được đính kèm vào một khoá học trong một bộ tài liệu.

Biểu diễn dưới dạng 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.
}
Trường
Trường hợp hợp nhất material. Dữ liệu Material. material chỉ có thể là một trong những loại sau:
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.

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 điểm tổng thể.
displaySetting

enum (DisplaySetting)

Cho biết những người có thể xem tổng điểm.
gradeCategories[]

object (GradeCategory)

Danh mục điểm có sẵn cho bài tập 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 nào. Giá trị này không bao giờ được trả về.
TOTAL_POINTS Tổng điểm là tổng điểm chia cho tổng số điểm, bất kể danh mục.
WEIGHTED_CATEGORIES Tổng điểm 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 nào. Giá trị này không bao giờ được trả về.
SHOW_OVERALL_GRADE Hiển thị tổng điểm trong sổ điểm và hồ sơ học viên cho cả giáo viên và 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 thấy tổng điểm trong sổ điểm và hồ sơ học viên. Ẩn khỏi học viên trong hồ sơ học viên.

Phương thức

checkAddOnCreationEligibility
(deprecated)

 Trả về thông tin 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 về việc người dùng có đủ điều kiện cập nhật GradingPeriodSettings trong một khoá học cụ thể 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ỉ những khoá học phù hợp với yêu cầu mới được xem.

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.