Method: courses.studentGroups.patch

یک یا چند فیلد را در یک گروه دانشجویی به‌روزرسانی می‌کند.

این متد کدهای خطای زیر را برمی‌گرداند:

  • اگر کاربر درخواست‌کننده مجاز به تغییر گروه دانشجویی درخواستی نباشد یا خطاهای دسترسی رخ دهد، PERMISSION_DENIED .
  • اگر گروه دانشجویی وجود نداشته باشد یا کاربر به گروه دانشجویی دسترسی نداشته باشد، NOT_FOUND .
  • اگر فیلدهای نامعتبر در ماسک به‌روزرسانی مشخص شده باشند یا هیچ ماسک به‌روزرسانی ارائه نشده باشد، INVALID_ARGUMENT .

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

پارامترهای مسیر

پارامترها
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

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