REST Resource: courses

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

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)
  }
}
Các trường
id

string

Mã 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 giao 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 của khoá học. Ví dụ: "Sinh học lớp 10". Bạn phải nhập tên. Mã này phải dài từ 1 đến 750 ký tự và phải là một chuỗi UTF-8 hợp lệ.

section

string

Một 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 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á 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 sinh vật sống nhờ sự kết hợp giữa sách giáo khoa, bài giảng của khách và bài tập trong phòng thí nghiệm. Hy vọng rằng bạn sẽ rất hào hứng!" 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 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
  • giá trị cố định kiểu chuỗi "me", cho biết người dùng đưa ra yêu cầu

Bạn phải đặt thuộc tính 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 trường hợp khác, giá trị này ở chế độ chỉ đọ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.

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

updateTime

string (Timestamp format)

Thời gian diễn ra lần cập nhật khoá học này gần đây nhất. 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.

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

enrollmentCode

string

Mã đăng ký để 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.

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 gồm tất cả giáo viên tham gia 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.

courseGroupEmail

string

Địa chỉ email của một nhóm trên Google có chứa tất cả thành viên trong 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.

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 trong 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.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

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

Chỉ đọc.

guardiansEnabled

boolean

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

Chỉ đọc.

calendarId

string

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

Lịch cho 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 lên 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.

gradebookSettings

object (GradebookSettings)

Chế độ cài đặt sổ điểm cho biết cách tính tổng điểm của học viên trong khoá học và hiển thị điểm cho ai.

Chỉ có thể đọc

CourseState

Các trạng thái có thể của 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 được trả về về Khoá học sẽ sử dụng giá trị này.
ACTIVE Khoá học này đang hoạt động.
ARCHIVED Khoá học đã được lưu trữ. Bạn không thể sửa đổi nó trừ phi thay đổi nó 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 được. Họ có thể sửa đổi hoặc thay đổi lớp này sang trạng thái ACTIVE hoặc DECLINED. Bạn chỉ có thể thay đổi một khoá học thành PROVISIONED nếu khoá học ở 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 được, mặc dù tệp này sẽ không hiển thị 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á 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 ở 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 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 sẽ 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 chương trình học, 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)
    }
  ]
}
Các trường
title

string

Tiêu đề của tập hợp này.

materials[]

object (CourseMaterial)

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

CourseMaterial

Một tài liệu được đính kèm vào khoá học trong 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.
}
Các trường
Trường nhóm material. Dữ liệu quan trọng. material chỉ có thể là một trong những trạng thái sau đây:
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 của một khoá học. Hãy xem bài viết này trong 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)
    }
  ]
}
Các 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)

Loại điểm có sẵn cho bài tập trong khoá học.

CalculationType

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

Enum
CALCULATION_TYPE_UNSPECIFIED Chưa chỉ định phương thức nào. Hệ thống sẽ không bao giờ trả về dữ liệu này.
TOTAL_POINTS Tổng điểm là tổng điểm chia cho tổng điểm bất kể loại điểm.
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ị tổng điểm.

Enum
DISPLAY_SETTING_UNSPECIFIED Chưa chỉ định chế độ cài đặt nào. Hệ thống sẽ không bao giờ trả về dữ liệu này.
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 tổng điểm trong sổ điểm hoặc hồ sơ học viên.
SHOW_TEACHERS_ONLY Hiện tổng điểm cho giáo viên trong sổ điểm và hồ sơ học viên. Ẩn học viên trong hồ sơ học viên.

Phương thức

checkAddOnCreationEligibility

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.

create

Tạo khoá học.

delete

Xoá khoá học.

get

Trả về 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 một khoá học.