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 によって割り当てられた ID（コースごとに一意）。

読み取り専用です。
text

string

このお知らせの説明。テキストは 30,000 文字以下の有効な UTF-8 文字列にする必要があります。
materials[]

object (Material)

補足資料

お知らせに含めるマテリアル アイテムは 20 個以内にしてください。
state

enum (AnnouncementState)

このお知らせのステータス。指定しない場合、デフォルトの状態は DRAFT です。
creationTime

string (Timestamp format)

このお知らせが作成されたときのタイムスタンプ。

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

このお知らせに対する最新の変更のタイムスタンプ。

読み取り専用です。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
scheduledTime

string (Timestamp format)

このお知らせの公開予定時刻のタイムスタンプ（省略可）。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
assigneeMode

enum (AssigneeMode)

お知らせの割り当て先モード。指定しない場合、デフォルト値は ALL_STUDENTS です。
individualStudentsOptions

object (IndividualStudentsOptions)

お知らせにアクセスできる生徒の識別子。このフィールドは、assigneeMode が INDIVIDUAL_STUDENTS の場合にのみ設定されます。assigneeMode が INDIVIDUAL_STUDENTS の場合、このフィールドに指定された生徒のみにお知らせが表示されます。
creatorUserId

string

お知らせを作成したユーザーの識別子。

読み取り専用です。

AnnouncementState

お知らせの各ステータス

列挙型
ANNOUNCEMENT_STATE_UNSPECIFIED 状態が指定されていません。これが返されることはありません。
PUBLISHED 公開されたお知らせのステータス。これがデフォルトの状態です。
DRAFT まだ公開されていないお知らせのステータス。この状態のお知らせは、コースの教師とドメイン管理者にのみ表示されます。
DELETED 公開されたが、現在は削除されているお知らせのステータス。この状態のお知らせは、コースの教師とドメイン管理者にのみ表示されます。このステータスのお知らせはしばらくすると削除されます。

メソッド

create

 お知らせを作成します。

delete

 お知らせを削除します。

get

 お知らせを返します。

getAddOnContext

 特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。

list

 リクエスト元に閲覧が許可されているお知らせのリストを返します。

modifyAssignees

 お知らせの割り当て先のモードとオプションを変更します。

patch

 お知らせの 1 つ以上のフィールドを更新します。