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

このお知らせに Classroom によって割り当てられた識別子（コースごとに一意）。

読み取り専用です。
text

string

このお知らせの説明。テキストは、30,000 文字以内の有効な UTF-8 文字列にする必要があります。
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

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