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。

唯讀。

id

string

Classroom 指派給這個公告的 ID,每個課程均有專屬的 ID。

唯讀。

text

string

這項公告的說明。文字必須是 UTF-8 字串,且最多只能包含 30,000 個半形字元。

materials[]

object (Material)

其他資料。

公告最多只能有 20 個教材項目。

state

enum (AnnouncementState)

這項公告的狀態,如果未指定,則預設狀態為 DRAFT

creationTime

string (Timestamp format)

建立這則公告時的時間戳記。

唯讀。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

這則公告最近變更的時間戳記。

唯讀。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

scheduledTime

string (Timestamp format)

(選填) 排定發布這則公告的時間。

RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

assigneeMode

enum (AssigneeMode)

公告的指派對像模式。如果未指定,則預設值為 ALL_STUDENTS

individualStudentsOptions

object (IndividualStudentsOptions)

具備公告存取權的學生 ID。只有在 assigneeModeINDIVIDUAL_STUDENTS 時,才需要設定此欄位。如果 assigneeModeINDIVIDUAL_STUDENTS,則只有這個欄位中指定的學生看得到公告。

creatorUserId

string

建立公告的使用者 ID。

唯讀。

AnnouncementState

可能的公告狀態

列舉
ANNOUNCEMENT_STATE_UNSPECIFIED 未指定州。系統絕不會傳回這個內容。
PUBLISHED 已發布公告的狀態。此為預設狀態。
DRAFT 尚未發布的公告狀態。只有課程老師和網域管理員才能查看這個狀態的公告。
DELETED 公告狀態:已發布但現已刪除。只有課程老師和網域管理員才能查看這個狀態的公告。這個狀態的公告會在一段時間後刪除。

方法

create

建立公告。

delete

刪除公告。

get

傳回公告。

getAddOnContext

取得 Classroom 外掛程式與特定訊息相關的中繼資料。

list

傳回允許要求者查看的公告清單。

modifyAssignees

修改公告的指派對像模式和選項。

patch

更新公告的一或多個欄位。