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

תיאור ההודעה הזו. הטקסט חייב להיות מחרוזת UTF-8 חוקית שמכילה עד 30,000 תווים.
materials[]

object (Material)

חומרים נוספים.

הודעות יכולות לכלול 20 פריטי תוכן לכל היותר.
state

enum (AnnouncementState)

הסטטוס של ההודעה הזו. אם לא צוין מצב ברירת המחדל, מצב ברירת המחדל הוא DRAFT.
creationTime

string (Timestamp format)

חותמת הזמן של מועד יצירת ההודעה.

קריאה בלבד.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

חותמת הזמן של השינוי האחרון בהודעה.

קריאה בלבד.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
scheduledTime

string (Timestamp format)

חותמת זמן אופציונלית של מועד פרסום ההודעה הזו.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

מצבי ההודעות האפשריים

טיפוסים בני מנייה (enums)
ANNOUNCEMENT_STATE_UNSPECIFIED לא צוינה מדינה. המידע הזה לא מוחזר אף פעם.
PUBLISHED סטטוס ההודעה שפורסמה. זהו מצב ברירת המחדל.
DRAFT סטטוס של הודעה שעדיין לא פורסמה. הודעה במצב זה גלויה רק למורים של הקורסים ולמנהלי הדומיין.
DELETED סטטוס ההודעה שפורסמה אבל נמחקה. הודעה במצב זה גלויה רק למורים של הקורסים ולמנהלי הדומיין. הודעה במצב הזה נמחקת לאחר זמן מה.

שיטות

create

 יצירת הודעה.

delete

 מחיקת הודעה.

get

 מחזירה הודעה.

getAddOnContext

 קבלת מטא-נתונים של תוספים ל-Classroom בהקשר של פוסט ספציפי.

list

 מחזירה רשימה של הודעות למגיש הבקשה.

modifyAssignees

 שינוי של מצב מקבל ההקצאה והאפשרויות של הודעות.

patch

 עדכון שדה אחד או יותר של הודעה.