افزونه های Google Classroom اکنون به طور کلی در دسترس توسعه دهندگان هستند! لطفاً برای اطلاعات بیشتر به
اسناد افزونه ها مراجعه کنید.
Method: courses.studentGroups.patch
با مجموعه‌ها، منظم بمانید
ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.
یک یا چند فیلد را در یک گروه دانشجویی به روز می کند.
این روش کدهای خطای زیر را برمی گرداند:
-
PERMISSION_DENIED اگر کاربر درخواست کننده مجاز به تغییر گروه دانشجویی درخواستی یا خطاهای دسترسی نباشد . - اگر گروه دانش آموزی وجود نداشته باشد یا کاربر به گروه دانش آموزی دسترسی نداشته باشد،
NOT_FOUND . - اگر فیلدهای نامعتبر در ماسک به‌روزرسانی مشخص شده باشد یا اگر ماسک به‌روزرسانی ارائه نشده باشد،
INVALID_ARGUMENT .
درخواست HTTP
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
courseId | string مورد نیاز. شناسه دوره |
id | string مورد نیاز. شناسه گروه دانشجویی |
پارامترهای پرس و جو
| پارامترها |
|---|
updateMask | string ( FieldMask format) مورد نیاز. ماسکی که مشخص می کند کدام فیلدها در گروه دانش آموزی باید به روز شوند. این فیلد برای انجام به روز رسانی لازم است. اگر فیلدهای نامعتبر مشخص شوند، به روز رسانی انجام نمی شود. فیلدهای زیر را می توان توسط معلمان مشخص کرد: این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" . |
previewVersion | enum ( PreviewVersion ) اختیاری. نسخه پیش نمایش نقطه پایانی. این باید برای دسترسی به قابلیت‌های API جدیدی که در برنامه پیش‌نمایش برای توسعه‌دهندگان در دسترس است، تنظیم شود. |
درخواست بدن
بدنه درخواست شامل یک نمونه از StudentGroup است.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از StudentGroup است.
محدوده مجوز
به محدوده OAuth زیر نیاز دارد:
-
https://www.googleapis.com/auth/classroom.rosters
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-08-08 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-08-08 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: courses.studentGroups.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\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20250630_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nUpdates one or more fields in a student group.\n\n\u003cbr /\u003e\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to modify the requested student group or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `NOT_FOUND` if the student group does not exist or the user does not have access to the student group.\n- `INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied.\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-----------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `id` | `string` Required. Identifier of the student group. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Required. Mask that identifies which fields on the student group to update. This field is required to do an update. The update fails if invalid fields are specified. The following fields can be specified by teachers: - `title` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The endpoint preview version. This must be set in order to access new API capabilities made available to developers in the Preview Program. |\n\n### Request body\n\nThe request body contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Response body\n\nIf successful, the response body contains an instance of [StudentGroup](/workspace/classroom/reference/rest/v1/courses.studentGroups#StudentGroup).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.rosters`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
