Method: courses.announcements.patch

یک یا چند قسمت از یک اعلامیه را به روز می کند.

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

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

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

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

مولفه های
courseId

string

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

id

string

شناسه اعلامیه

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

مولفه های
updateMask

string ( FieldMask format)

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

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

  • text
  • state
  • scheduledTime

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

درخواست بدن

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

بدن پاسخگو

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

محدوده مجوز

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

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

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