您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门 - 了解如何在 Google Meet 课程中查看学生出席情况

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”仍由“课堂”分配,且无法在课程创建后更新。

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

name

string

课程的名称。例如,“10 年级生物学”。必须提供名称。它必须包含 1 到 750 个字符,并且是有效的 UTF-8 字符串。

section

string

课程部分。例如,“时间段 2”。如果已设置,此字段必须是有效的 UTF-8 字符串,且长度不能超过 2800 个字符。

descriptionHeading

string

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

description

string

可选的说明。例如,“我们将从教科书、讲课和实验室工作中学习生物的生物结构。不要再期待!” 如果设置,此字段必须是有效的 UTF-8 字符串,长度不超过 30000 个字符。

room

string

聊天室的可选位置。例如:“301”。如果设置,此字段必须是有效的 UTF-8 字符串,长度不超过 650 个字符。

ownerId

string

课程所有者的标识符。

指定为 create course request 的参数时,此字段为必填字段。标识符可以是下列之一:

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

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

creationTime

string (Timestamp format)

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

只读。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式且采用纳秒分辨率(最多 9 个小数位)的时间戳。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

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

只读。

采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式且采用纳秒分辨率(最多 9 个小数位)的时间戳。示例:"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 添加到课程作业和课程中的通知活动中。

只读。

gradebookSettings

object (GradebookSettings)

成绩册设置,用于指定学生的总体课程成绩计算方式和显示对象。

只读

课程状态

课程可能所处的状态。

枚举
COURSE_STATE_UNSPECIFIED 无课程状态。返回的课程信息不会使用此值。
ACTIVE 课程有效。
ARCHIVED 此课程已归档。您不能修改它,除非更改为其他状态。
PROVISIONED 此课程已创建完毕,但尚未启用。主讲教师和网域管理员可以修改此表格,或将其设置为 ACTIVEDECLINED 状态。只能将课程更改为PROVISIONED如果位于DECLINED状态。
DECLINED 此课程已创建完毕,但遭到拒绝。课程所有者和网域管理员可以访问该工具,但网页界面中不会显示该工具。您不能修改课程,除非将其更改为 PROVISIONED 状态。只能将课程更改为DECLINED如果位于PROVISIONED状态。
SUSPENDED 该课程已被暂停。您不能修改课程,只有 ownerId 的用户才能查看此课程。如果某个课程可能违反了《服务条款》,则可能会处于此状态。

课程资料集

出现在课程“简介”页面上的一组资料。这些资料可能包括考试大纲、课程表或其他与整体课程相关的背景信息。

JSON 表示法
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
字段
title

string

此集合的标题。

materials[]

object (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 只能是下列其中一项:
driveFile

object (DriveFile)

Google 云端硬盘文件附件。

youTubeVideo

object (YouTubeVideo)

YouTube 视频附件。

form

object (Form)

Google 表单附件。

成绩册设置

课程的成绩册设置。如需了解详情,请参阅这篇帮助中心文章

JSON 表示法
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
字段
calculationType

enum (CalculationType)

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

displaySetting

enum (DisplaySetting)

表明哪些人可以查看总体成绩。

gradeCategories[]

object (GradeCategory)

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

计算类型

总体成绩计算方式。

枚举
CALCULATION_TYPE_UNSPECIFIED 未指定方法。系统绝不会返回此代码。
TOTAL_POINTS 总体成绩是成绩的和除以总分的总和(不管类别)。
WEIGHTED_CATEGORIES 总体成绩是按类别加权得到的平均值。

显示设置

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

枚举
DISPLAY_SETTING_UNSPECIFIED 未指定任何设置。系统绝不会返回此代码。
SHOW_OVERALL_GRADE 向教师和学生显示成绩册和学生个人资料的总体成绩。
HIDE_OVERALL_GRADE 不在成绩册或学生资料中显示总体成绩。
SHOW_TEACHERS_ONLY 在成绩册和学生个人资料中向教师显示总体成绩。在学生个人资料中隐藏,不向学生显示。

方法

create

创建课程。

delete

删除课程。

get

返回课程。

list

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

patch

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

update

更新课程。