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

Google 课堂为此通知分配的标识符,每个课程的标识符都是唯一的。

只读。

text

string

此通告的说明。文本必须是有效的 UTF-8 字符串,且不得超过 3 万个字符。

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 时,系统才会设置此字段。如果 assigneeModeINDIVIDUAL_STUDENTS,则只有在此字段中指定的学生才能看到通知。

creatorUserId

string

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

只读。

AnnouncementState

公告的可能状态

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

方法

create

创建通知。

delete

删除通知。

get

返回一条通知。

getAddOnContext

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

list

返回请求者有权查看的通告列表。

modifyAssignees

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

patch

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