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)
מסכה שמזהה אילו שדות בקורס צריך לעדכן. חובה למלא את השדה הזה כדי לבצע עדכון. העדכון ייכשל אם יצוינו שדות לא תקינים. השדות הבאים הם חוקיים:
namesectiondescriptionHeadingdescriptionroomcourseStateownerId הערה: תיקונים של ownerId נחשבים כתיקונים שנכנסים לתוקף באופן מיידי, אבל בפועל יכול להיות שיעבור זמן עד שהעברת הבעלות של כל המשאבים המושפעים תושלם. כשמגדירים את השדה הזה כפרמטר של שאילתה, צריך לציין אותו כך: updateMask=<field1>,<field2>,...
זוהי רשימה של שמות שדות שמוגדרים במלואם, שמופרדים באמצעות פסיקים. דוגמה: "user.displayName,photo"
|
גוף הבקשה
גוף הבקשה מכיל מופע של Course.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Course.
היקפי הרשאה
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/classroom.courses
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-08 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-08 (שעון UTC)."],[],[],null,["# Method: courses.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates one or more fields in a course.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if no course exists with the requested ID.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n- `FAILED_PRECONDITION` for the following [request errors](/workspace/classroom/reference/Request.Errors):\n - CourseNotModifiable\n - InactiveCourseOwner\n - IneligibleOwner\n - CourseTitleCannotContainUrl\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` Identifier of the course to update. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Mask that identifies which fields on the course to update. This field is required to do an update. The update will fail if invalid fields are specified. The following fields are valid: - `name` - `section` - `descriptionHeading` - `description` - `room` - `courseState` - `ownerId` Note: patches to ownerId are treated as being effective immediately, but in practice it may take some time for the ownership transfer of all affected resources to complete. When set in a query parameter, this field should be specified as `updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Response body\n\nIf successful, the response body contains an instance of [Course](/workspace/classroom/reference/rest/v1/courses#Course).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
