Method: courses.patch

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

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

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

درخواست HTTP

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

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

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

پارامترها
id

string

شناسه دوره برای به‌روزرسانی. این شناسه می‌تواند شناسه اختصاص داده شده توسط کلاس درس یا یک alias باشد.

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

پارامترها
updateMask

string ( FieldMask format)

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

  • courseState
  • description
  • descriptionHeading
  • name
  • ownerId
  • room
  • section
  • subject

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

هنگام تنظیم پارامتر پرس و جو، این فیلد باید به صورت زیر مشخص شود

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

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

درخواست بدنه

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

بدنه پاسخ

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

دامنه‌های مجوز

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

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

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