Method: courses.patch

یک یا چند فیلد را در یک دوره به روز می کند.

این روش کدهای خطای زیر را برمی گرداند:

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

درخواست 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

توجه: وصله‌های مالکیت به‌عنوان فوراً مؤثر تلقی می‌شوند، اما در عمل ممکن است مدتی طول بکشد تا انتقال مالکیت همه منابع تحت تأثیر کامل شود.

هنگامی که در یک پارامتر query تنظیم می شود، این فیلد باید به صورت مشخص شود

updateMask=<field1>,<field2>,...

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

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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