REST Resource: courses

{
  "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)
  }
}

string

Google 课堂分配给此课程的标识符。

如果为 creating a course，您可以选择在请求中将此标识符设置为 alias string，以创建相应的别名。id 仍由 Google 课堂分配，在课程创建后无法更新。

在课程更新掩码中指定此字段会导致错误。

string

课程的名称。例如，“10 年级生物学”。此名称为必填项。它必须包含 1 到 750 个字符，且为有效的 UTF-8 字符串。

string

课程的部分。例如“第 2 学期”。如果设置，此字段必须是有效的 UTF-8 字符串，且不得超过 2800 个字符。

string

说明的可选标题。例如，“欢迎学习 10 年级生物学”。如果设置，此字段必须是有效的 UTF-8 字符串，且不得超过 3600 个字符。

string

可选说明。例如，“我们将通过教科书、客座讲座和实验课程综合学习生物的结构。期待您满意！”如果设置此字段，则其必须是有效的 UTF-8 字符串，且不得超过 3 万个字符。

string

可选的房间位置。例如“301”。如果设置，此字段必须是有效的 UTF-8 字符串，且长度不得超过 650 个字符。

string

课程所有者的标识符。

将此字段指定为 create course request 的参数时，此字段为必填字段。标识符可以是以下值之一：

• 用户的数字标识符
• 用户的电子邮件地址
• 字符串字面量 "me"，表示请求用户

此字段必须在创建请求中设置。管理员还可以在 patch course request 中指定此字段以转让所有权。在其他上下文中，它是只读的。

string (Timestamp format)

课程的创建时间。在课程更新掩码中指定此字段会导致错误。

只读。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string (Timestamp format)

此课程的最近更新时间。在课程更新掩码中指定此字段会导致错误。

只读。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

string

加入此课程时使用的注册代码。在课程更新掩码中指定此字段会导致错误。

只读。

enum (CourseState)

课程的状态。如果未指定，则默认状态为 PROVISIONED。

string

Google 课堂网页界面中指向本课程的绝对链接。

只读。

string

包含该课程所有教师的 Google 群组的电子邮件地址。此群组不接受电子邮件，只能用于权限。

只读。

string

包含课程所有成员的 Google 群组的电子邮件地址。此群组不接受电子邮件，只能用于权限请求。

只读。

object (DriveFolder)

与课程的所有教师共享的云端硬盘文件夹的相关信息。

只有课程教师和网域管理员才能设置此字段。

只读。

object (CourseMaterialSet)

此课程“简介”页面上显示的材料集。

只读。

boolean

是否为此课程启用监护人通知。

只读。

string

一个日历的 ID，该日历可供所有课程成员查看，Google 课堂会向其中添加课程作业和课程通知的活动。

当课程首次设为 CourseState.ACTIVE（在创建时或通过界面或 API 将其更新为 ACTIVE 时）时，系统会异步创建课程的日历。在创建流程完成之前，系统不会填充日历 ID。

只读。

object (GradebookSettings)

成绩册设置，用于指定如何计算学生的课程总体成绩以及向谁显示成绩。

只读

{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}

string

此资源集的标题。

object (CourseMaterial)

这组资料附加了资料。

{

  // 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.
}

object (DriveFile)

Google 云端硬盘文件附件。

object (YouTubeVideo)

YouTube 视频附件。

object (Link)

链接附件。

object (Form)

Google 表单附件。

{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}

enum (CalculationType)

指明总体成绩的计算方式。

enum (DisplaySetting)

指明谁可以查看总体成绩。

object (GradeCategory)

课程作业中可用的成绩类别。