REST Resource: courses.announcements

资源:通告

教师为课程的学生创建的通知

JSON 表示法
{
  "courseId": string,
  "id": string,
  "text": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (AnnouncementState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string
}
字段
courseId

string

课程的标识符。

只读。

id

string

由课堂指定的此通知标识符,每个课程都是唯一的。

只读。

text

string

此通知的说明。文本必须是不超过 30,000 个字符的有效 UTF-8 字符串。

materials[]

object (Material)

其他资料。

通知包含的重要内容项不得超过 20 项。

state

enum (AnnouncementState)

此通知的状态。如果未指定,则默认状态为 DRAFT

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"

scheduledTime

string (Timestamp format)

计划发布此通知时的可选时间戳。

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

assigneeMode

enum (AssigneeMode)

通知的分配对象模式。如果未指定,则默认值为 ALL_STUDENTS

individualStudentsOptions

object (IndividualStudentsOptions)

有权访问通知的学生的标识符。仅当 assigneeModeINDIVIDUAL_STUDENTS 时,才会设置此字段。如果assigneeMode为“INDIVIDUAL_STUDENTS”,则只有此字段中指定的学生才能看到通知。

creatorUserId

string

创建通知的用户的标识符。

只读。

通告状态

通知的可能状态

枚举
ANNOUNCEMENT_STATE_UNSPECIFIED 未指定任何州。此值永远不会返回。
PUBLISHED 已发布通知的状态。这是默认状态。
DRAFT 尚未发布的通知的状态。只有课程教师和网域管理员可以看到处于此状态的通知。
DELETED 已发布但现已删除的通知状态。只有课程教师和网域管理员可以看到处于此状态的通知。处于此状态的通知会在一段时间后被删除。

方法

create

创建通知。

delete

删除通知。

get

返回通知。

getAddOnContext

在特定帖子中获取 Google 课堂插件的元数据。

list

返回请求者可以查看的通知列表。

modifyAssignees

修改通知的分配对象模式和选项。

patch

更新通知的一个或多个字段。