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)

مورد نیاز. ماسکی که مشخص می کند کدام فیلدها در گروه دانش آموزی باید به روز شوند. این فیلد برای انجام به روز رسانی لازم است. اگر فیلدهای نامعتبر مشخص شوند، به روز رسانی انجام نمی شود.

فیلدهای زیر را می توان توسط معلمان مشخص کرد:

  • title

این فهرستی از نام‌های فیلدهای کاملاً واجد شرایط با کاما است. مثال: "user.displayName,photo" .

previewVersion

enum ( PreviewVersion )

اختیاری. نسخه پیش نمایش نقطه پایانی. این باید برای دسترسی به قابلیت‌های API جدیدی که در برنامه پیش‌نمایش برای توسعه‌دهندگان در دسترس است، تنظیم شود.

درخواست بدن

بدنه درخواست شامل یک نمونه از StudentGroup است.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از StudentGroup است.

محدوده مجوز

به محدوده OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.