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，每門課程皆不相同。

唯讀。
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)

可查看公告的學生 ID。只有在 assigneeMode 為 INDIVIDUAL_STUDENTS 時，系統才會設定這個欄位。如果 assigneeMode 是 INDIVIDUAL_STUDENTS，則只有在這個欄位中指定的學生才能看到公告。
creatorUserId

string

建立公告的使用者 ID。

唯讀。

AnnouncementState

公告的可能狀態

列舉
ANNOUNCEMENT_STATE_UNSPECIFIED 未指定狀態。系統不會傳回這項值。
PUBLISHED 已發布的公告狀態。這是預設狀態。
DRAFT 尚未發布的公告狀態。只有課程老師和網域管理員才能查看處於這項狀態的公告。
DELETED 已發布但已刪除的公告狀態。只有課程老師和網域管理員才能看到處於這項狀態的公告。處於此狀態的公告會在一段時間後刪除。

方法

create

 建立公告。

delete

 刪除公告。

get

 傳回公告。

getAddOnContext

 取得特定貼文脈絡中 Classroom 外掛程式的中繼資料。

list

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

modifyAssignees

 修改指派者模式和公告選項。

patch

 更新一或多個公告欄位。