Method: courses.patch

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

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

פרמטרים
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

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