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 ל-Classroom.

קריאה בלבד.
text

string

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

object (Material)

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

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

enum (AnnouncementState)

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

string (Timestamp format)

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

קריאה בלבד.

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

string (Timestamp format)

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

קריאה בלבד.

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

string (Timestamp format)

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

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

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

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

שיטות

create

 יצירת הודעה.

delete

 מחיקת הודעה.

get

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

getAddOnContext

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

list

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

modifyAssignees

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

patch

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