Method: courses.courseWorkMaterials.patch

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

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

  • اگر پروژه توسعه‌دهنده درخواست‌کننده برای دسترسی خطا داشته باشد، PERMISSION_DENIED .
  • اگر درخواست ناقص باشد، INVALID_ARGUMENT .
  • اگر مطالب درسی درخواستی قبلاً حذف شده باشد، FAILED_PRECONDITION .
  • اگر دوره یا مطالب آموزشی درخواستی وجود نداشته باشد، NOT_FOUND

درخواست HTTP

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

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

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

پارامترها
courseId

string

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

id

string

شناسه‌ی مطالب آموزشی دوره.

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

پارامترها
updateMask

string ( FieldMask format)

ماسکی که مشخص می‌کند کدام فیلدها در محتوای دوره آموزشی باید به‌روزرسانی شوند. این فیلد برای انجام به‌روزرسانی مورد نیاز است. اگر فیلدهای نامعتبر مشخص شوند، به‌روزرسانی با شکست مواجه می‌شود. اگر فیلدی از مقادیر خالی پشتیبانی کند، می‌توان آن را با مشخص کردن در ماسک به‌روزرسانی و نه در شیء محتوای دوره آموزشی پاک کرد. اگر فیلدی که از مقادیر خالی پشتیبانی نمی‌کند در ماسک به‌روزرسانی گنجانده شده باشد و در شیء محتوای دوره آموزشی تنظیم نشده باشد، خطای INVALID_ARGUMENT بازگردانده می‌شود.

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

  • title
  • description
  • state
  • scheduledTime
  • topicId

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

previewVersion

enum ( PreviewVersion )

اختیاری. نسخه پیش‌نمایش نقطه پایانی.

PREVIEW_VERSION_9001 شامل قابلیت‌های جدیدی است: * به‌روزرسانی‌های مواد پشتیبانی می‌شوند. برای به‌روزرسانی مواد، از updateMask "materials" استفاده کنید. فهرست مواد ارائه شده در شیء CourseWorkMaterial درخواست، به طور کامل جایگزین فهرست موجود خواهد شد. فیلد مواد را می‌توان با مشخص کردن "materials" در ماسک به‌روزرسانی و نه در شیء CourseWorkMaterial پاک کرد. به‌روزرسانی‌های منتشر شده CourseWorkMaterial در حال حاضر پشتیبانی نمی‌شوند.

درخواست بدنه

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

بدنه پاسخ

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

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

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

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

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