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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.