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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
字段
id

string

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

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

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

string

课程名称。例如，“10 年级生物”。此名称为必填项。长度必须介于 1 到 750 个字符之间，且必须是有效的 UTF-8 字符串。
section

string

课程的章节。例如，“Period 2”。如果设置，此字段必须是有效的 UTF-8 字符串，且长度不得超过 2800 个字符。
descriptionHeading

string

说明的可选标题。例如，“欢迎学习高一生物学”。如果设置，此字段必须是有效的 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)

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

只读。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

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

只读。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
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 课堂会向该日历添加课程作业和课程通知对应的活动。

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

只读。
gradebookSettings

object (GradebookSettings)

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

只读。
subject

string

可选。课程的主题。
learningStandardSettings

object (CourseLearningStandardSettings)

可选。

与课程中提供的学业标准相关的设置。一门课程最多只能分配 20 个学业标准集根。
levels

string

可选。课程的级别。示例：“9th grade”（九年级）、“Middle school”（初中）、“4th - 5th”（四年级至五年级）、“K-2”（幼儿园至二年级）、“3000”。如果设置，此字段必须是有效的 UTF-8 字符串，且少于 1, 000 个字符。

此字段只能使用 courses.patch 方法清除。

CourseState

课程可能处于的状态。

枚举
COURSE_STATE_UNSPECIFIED 无课程状态。任何返回的 Course 消息都不会使用此值。
ACTIVE 课程处于有效状态。
ARCHIVED 此课程已归档。您无法修改它，但可以将其更改为其他状态。
PROVISIONED 课程已创建，但尚未激活。主讲教师和网域管理员可以访问该课程，并可以修改该课程或将其更改为 ACTIVE 或 DECLINED 状态。只有当课程处于 DECLINED 状态时，才能将其更改为 PROVISIONED。
DECLINED 课程已创建，但被拒绝。课程所有者和网域管理员可以访问该课程，但该课程不会显示在 Web 界面中。您无法修改课程，但可以将其更改为 PROVISIONED 状态。只有当课程处于 PROVISIONED 状态时，才能将其更改为 DECLINED。
SUSPENDED 课程已暂停。您无法修改课程，并且只有 ownerId 标识的用户才能查看课程。如果课程可能违反《服务条款》，则可能会被置于此状态。

CourseMaterialSet

课程“关于”页面上显示的一组资料。这些资料可能包括课程大纲、时间表或与整个课程相关的其他背景信息。

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

string

此集合的标题。
materials[]

object (CourseMaterial)

此组中附加的资料。

CourseMaterial

作为资料集的一部分附加到课程的资料。

JSON 表示法 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
字段
材料数据。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
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 在成绩册和学生个人资料中向教师显示总体成绩。在学生个人资料中对学生隐藏。

CourseLearningStandardSettings

课程的学业标准设置。

JSON 表示法 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
字段
standardSets[]

object (LearningStandardSetRoot)

必需。应用于此课程的学业标准根集。

LearningStandardSetRoot

表示一组所选学业标准的根。在 Google 课堂界面中为信息流内容设置学习目标时，系统会显示所选根节点的后代。

JSON 表示法 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
字段
caseGuid

object (CaseGuid)

必需。学业标准集根的 Satchel Rosetta Exchange GUID。
documentTitle

string

仅限输出。学业标准集根目录的文档标题。
standardTitle

string

仅限输出。学业标准集根目录的标题。
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

仅限输出。学业标准集根的可用性状态。使用此字段可确定学业标准集根是否已从来源中删除。

方法

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 返回用户是否有资格更新指定课程中的 GradingPeriodSettings。

create

 创建课程。

delete

 删除课程。

get

 返回课程。

getGradingPeriodSettings

 返回课程中的评分周期设置。

list

 返回请求用户有权查看的课程列表，仅限于与请求匹配的课程。

patch

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

update

 更新课程。

updateGradingPeriodSettings

 更新课程的评分周期设置。