REST Resource: courses

资源：课程

Google 课堂中的课程。

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

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

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

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

string

课程的名称。例如，“10 年级生物学”。必须填写名称。该值必须介于 1 到 750 个字符之间，并且必须是有效的 UTF-8 字符串。
section

string

课程的一部分。例如，“时间段 2”。如果设置此参数，则此字段必须是有效的 UTF-8 字符串，且不得超过 2800 个字符。
descriptionHeading

string

说明的可选标题。例如，“欢迎来到 10 年级生物学”。如果设置此参数，则此字段必须是有效的 UTF-8 字符串，且不得超过 3600 个字符。
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)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

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

只读。

时间戳，采用 RFC3339 世界协调时间 (UTC)（即“祖鲁时”）格式，具有纳秒级分辨率，最多包含九个小数位。示例："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

所有课程成员都可以查看的日历的日历 ID。Google 课堂会在此 ID 中添加课程作业和课程通知。

首次将课程设为 CourseState.ACTIVE（在创建课程时，或者通过界面或 API 更新为 ACTIVE 时）课程时，系统将异步创建课程日历。完成创建过程后，系统才会填充日历 ID。

只读。
gradebookSettings

object (GradebookSettings)

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

只读

CourseState

课程可能存在的状态。

枚举
COURSE_STATE_UNSPECIFIED 没有课程状态。任何返回的课程消息都不会使用此值。
ACTIVE 课程处于有效状态。
ARCHIVED 该课程已归档。您无法对其进行修改，只有将其更改为其他状态。
PROVISIONED 课程已创建，但尚未激活。主讲教师和网域管理员均可访问这份演示文稿，并可以进行修改或将其更改为“ACTIVE”或“DECLINED”状态。课程只有在处于 DECLINED 状态时才能更改为 PROVISIONED。
DECLINED 课程已创建，但遭到拒绝。课程所有者和网域管理员可以访问该文件，但不会显示在网页界面中。您不能修改课程，除非将其更改为PROVISIONED状态。课程只有在处于 PROVISIONED 状态时才能更改为 DECLINED。
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 数据。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

可能的总体成绩计算方式。

枚举
CALCULATION_TYPE_UNSPECIFIED 未指定方法。此值永远不会返回。
TOTAL_POINTS 总体成绩是成绩总和除以总分总和（不考虑类别）。
WEIGHTED_CATEGORIES 总体成绩是各类别的加权平均值。

DisplaySetting

可用于显示总体成绩的设置。

枚举
DISPLAY_SETTING_UNSPECIFIED 未指定任何设置。此值永远不会返回。
SHOW_OVERALL_GRADE 在成绩册和学生个人资料中向教师和学生显示总体成绩。
HIDE_OVERALL_GRADE 不会在成绩册或学生个人资料中显示总体成绩。
SHOW_TEACHERS_ONLY 在成绩册和学生个人资料中向教师显示总体成绩。学生个人资料不会向学生显示。

方法

checkAddOnCreationEligibility

 返回用户是否有资格在特定课程中创建插件附件。

create

 创建课程。

delete

 删除课程。

get

 返回课程。

list

 返回发出请求的用户可以查看的课程列表（仅限与请求匹配的课程）。

patch

 更新课程中的一个或多个字段。

update

 更新课程。