Method: courses.patch

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

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

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

בקשת HTTP

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

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

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