REST Resource: courses.announcements

资源:Announcement

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

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

相应公告的 Classroom 分配标识符,每个课程均唯一。

只读。

text

string

相应公告的说明。文本必须是有效的 UTF-8 字符串,且不得超过 30,000 个字符。

materials[]

object (Material)

其他资料。

公告不得包含超过 20 个素材资源。

state

enum (AnnouncementState)

相应公告的状态。如果未指定,则默认状态为 DRAFT

creationTime

string (Timestamp format)

相应公告的创建时间戳。

只读。

采用 RFC 3339 标准,生成的输出将始终在末尾带 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,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

scheduledTime

string (Timestamp format)

此公告计划发布的可选时间戳。

采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

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

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