Method: courses.patch

تُعدِّل حقلاً واحدًا أو أكثر في الدورة التدريبية.

تعرض هذه الطريقة رموز الخطأ التالية:

  • PERMISSION_DENIED إذا لم يكن مسموحًا للمستخدم الذي قدّم الطلب بتعديل الدورة التدريبية المطلوبة أو بسبب أخطاء الوصول.
  • NOT_FOUND إذا لم تكن هناك دورة تدريبية تحتوي على رقم التعريف المطلوب.
  • INVALID_ARGUMENT في حال تحديد حقول غير صالحة في قناع التحديث أو في حال عدم توفير أي قناع تحديث.
  • FAILED_PRECONDITION بسبب أخطاء الطلب التالية:
    • CourseNotModifiable
    • InactiveCourseOwner
    • IneligibleOwner

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
id

string

معرّف الدورة التدريبية المطلوب تحديثه. ويمكن أن يكون هذا المعرّف إمّا المعرّف الذي حدّده Classroom أو alias.

معلمات طلب البحث

المَعلمات
updateMask

string (FieldMask format)

قناع يحدد الحقول التي يجب تحديثها في الدورة التدريبية. هذا الحقل مطلوب لإجراء تعديل. سيتعذر التعديل في حال تحديد حقول غير صالحة. الحقول التالية صالحة:

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

ملاحظة: يتم التعامل مع التصحيحات المرسَلة إلى ownerId على أنّها سارية على الفور، ولكن من الناحية العملية، قد يستغرق اكتمال عملية نقل ملكية جميع الموارد المتأثّرة بعض الوقت.

عند ضبط الحقل مع معلَمة طلب بحث، يجب تحديد

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

هذه قائمة مفصولة بفواصل تضم أسماء الحقول المؤهلة بالكامل. مثال: "user.displayName,photo"

نص الطلب

يحتوي نص الطلب على مثال Course.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Course.

نطاقات التفويض

يجب توفير نطاق OAuth التالي:

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

لمزيد من المعلومات، راجِع دليل التفويض.