Method: courses.patch

تعدّل هذه الطريقة حقلًا واحدًا أو أكثر في دورة تدريبية.

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

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

طلب HTTP

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

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

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

المعلمات
id

string

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

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

المعلمات
updateMask

string (FieldMask format)

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

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

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

عند ضبط هذا الحقل في مَعلمة طلب البحث، يجب تحديده على النحو التالي:

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

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

نص الطلب

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

نص الاستجابة

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

نطاقات الأذونات

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

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

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