Method: courses.patch

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

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

  • PERMISSION_DENIED אם המשתמש ששלח את הבקשה לא מורשה לשנות את הקורס המבוקש או בגלל שגיאות גישה.
  • NOT_FOUND אם לא קיים קורס עם המזהה המבוקש.
  • INVALID_ARGUMENT אם צוינו שדות לא חוקיים במסכת העדכון או אם לא סופקה מסכת עדכון.
  • FAILED_PRECONDITION עבור שגיאות הבקשה הבאות:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner

בקשת HTTP

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

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

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

פרמטרים
id

string

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

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

פרמטרים
updateMask

string (FieldMask format)

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

  • name
  • section
  • descriptionHeading
  • description
  • room
  • courseState
  • ownerId

הערה: תיקונים ל- ownerId מטופלים באופן מיידי, אבל ייתכן שיחלוף זמן מה עד שהעברת הבעלות על כל המשאבים המושפעים תושלם.

כששדה זה מוגדר בפרמטר של שאילתה, יש לציין אותו כך:

updateMask=<field1>,<field2>,...

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

גוף הבקשה

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

גוף התגובה

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

היקפי הרשאות

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

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

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