您的用户是通过 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 字符串,且长度不得超过 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 课堂会添加课程作业和课程通知的活动。

只读。

gradebookSettings

object (GradebookSettings)

成绩册设置,可指定学生如何计算课程的总体成绩以及成绩由谁显示。

只读

课程状态

课程可能所处的状态。

枚举
COURSE_STATE_UNSPECIFIED 无课程状态。系统不会返回任何课程消息。
ACTIVE 课程已启用。
ARCHIVED 课程已归档。除非将其更改为其他状态,否则您不能对其进行修改。
PROVISIONED 课程已创建,但尚未激活。主讲教师和网域管理员可以访问此日历,并可以将其修改为 ACTIVEDECLINED 状态。课程只能处于“DECLINED”状态,才能更改为“PROVISIONED”。
DECLINED 课程已创建,但被拒。课程所有者和网域管理员可以访问此界面,但它不会显示在网页界面中。您不能修改课程,只能将其更改为 PROVISIONED 状态。课程只能处于“PROVISIONED”状态,才能更改为“DECLINED”。
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 数据。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

更新课程。