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)

חותמת הזמן שבה ההודעה הזו נוצרה.

קריאה בלבד.

הפלט שנוצר תמיד יהיה בפורמט 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)

מזהים של תלמידים שיש להם גישה להודעה. השדה הזה מוגדר רק אם הערך של assigneeMode הוא INDIVIDUAL_STUDENTS. אם הערך של assigneeMode הוא INDIVIDUAL_STUDENTS, רק התלמידים שצוינו בשדה הזה יכולים לראות את ההודעה.
creatorUserId

string

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

קריאה בלבד.

AnnouncementState

הסטטוסים האפשריים של הודעות

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

Methods

create

 יצירת עדכון.

delete

 מחיקת הודעה לכיתה.

get

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

getAddOnContext

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

list

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

modifyAssignees

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

patch

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