Method: courses.announcements.patch

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

השיטה הזו מחזירה את קודי השגיאה הבאים:

  • PERMISSION_DENIED אם ההודעה המתאימה לא נוצרה בפרויקט הפיתוח ששלח הבקשה או בגלל שגיאות גישה.
  • INVALID_ARGUMENT אם הבקשה לא תקינה.
  • FAILED_PRECONDITION אם ההודעה המבוקשת כבר נמחקה.
  • NOT_FOUND אם הקורס או ההודעה המבוקשים לא קיימים

בקשת HTTP

PATCH https://classroom.googleapis.com/v1/courses/{courseId}/announcements/{id}

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
courseId

string

מזהה הקורס. המזהה יכול להיות המזהה שהוקצה ל-Classroom או alias.
id

string

המזהה של ההודעה.

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

מסכה שמזהה את השדות בהודעה שיש לעדכן. השדה הזה נדרש לצורך ביצוע עדכון. העדכון ייכשל אם יצוינו שדות לא חוקיים. אם שדה תומך בערכים ריקים, ניתן לנקות אותו על ידי ציון שלו במסכת העדכון ולא באובייקט 'הודעות'. אם שדה שאינו תומך בערכים ריקים נכלל במסכת העדכון ולא מוגדר באובייקט ההודעה, תוחזר שגיאת INVALID_ARGUMENT.

המורים רשאים לציין את השדות הבאים:

  • text
  • state
  • scheduledTime

זוהי רשימה של שמות שדות מלאים, שמופרדים בפסיקים. דוגמה: "user.displayName,photo"

גוף הבקשה

גוף הבקשה מכיל מופע של Announcement.

גוף התגובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Announcement.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/classroom.announcements

למידע נוסף, ניתן לעיין במדריך ההרשאות.