Method: courses.announcements.patch

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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