REST Resource: courses

المرجع: دورة تدريبية

دورة تدريبية في Classroom:

تمثيل JSON
{
  "id": string,
  "name": string,
  "section": string,
  "descriptionHeading": string,
  "description": string,
  "room": string,
  "ownerId": string,
  "creationTime": string,
  "updateTime": string,
  "enrollmentCode": string,
  "courseState": enum (CourseState),
  "alternateLink": string,
  "teacherGroupEmail": string,
  "courseGroupEmail": string,
  "teacherFolder": {
    object (DriveFolder)
  },
  "courseMaterialSets": [
    {
      object (CourseMaterialSet)
    }
  ],
  "guardiansEnabled": boolean,
  "calendarId": string,
  "gradebookSettings": {
    object (GradebookSettings)
  }
}
الحقول
id

string

معرّف هذه الدورة التدريبية الذي تم تعيينه من قِبل Classroom.

عند creating a course، يمكنك اختياريًا ضبط هذا المعرّف على alias string في الطلب لإنشاء اسم مستعار مطابق. لا يزال Classroom مخصَّصًا للدورة التدريبية id ولا يمكن تعديله بعد إنشاء الدورة التدريبية.

يؤدي تحديد هذا الحقل في قناع تعديل الدورة التدريبية إلى حدوث خطأ.

name

string

تمثّل هذه السمة اسم الدورة التدريبية. على سبيل المثال، "علم الأحياء للصف العاشر". يجب إدخال الاسم. ويجب أن يتراوح عدد الأحرف بين حرف واحد و750 حرفًا وسلسلة UTF-8 صالحة.

section

string

قسم من الدورة التدريبية. على سبيل المثال، "الفترة 2". وفي حال ضبطها، يجب أن يكون هذا الحقل سلسلة UTF-8 صالحة وألا يزيد طولها عن 2800 حرف.

descriptionHeading

string

عنوان اختياري للوصف. على سبيل المثال، "مرحبًا بك في علم الأحياء للصف العاشر". وفي حال ضبطها، يجب أن يكون هذا الحقل سلسلة UTF-8 صالحة وألا يزيد طوله عن 3600 حرف.

description

string

وصف اختياري. على سبيل المثال، "سنتعرف على بنية الكائنات الحية من خلال مجموعة من الكتب الدراسية ومحاضرات الضيوف والأعمال في المختبر. توقع أن تكون متحمسًا!" وفي حال ضبطها، يجب أن يكون هذا الحقل سلسلة UTF-8 صالحة وألا يزيد طوله عن 30,000 حرف.

room

string

الموقع الجغرافي للغرفة اختياري. على سبيل المثال، "301". وفي حال ضبطها، يجب أن يكون هذا الحقل سلسلة UTF-8 صالحة وألا يزيد طوله عن 650 حرفًا.

ownerId

string

تشير هذه السمة إلى معرّف مالك الدورة التدريبية.

يكون هذا الحقل مطلوبًا عند تحديده كمَعلمة create course request. يمكن أن يكون المعرّف واحدًا مما يلي:

  • المعرّف الرقمي للمستخدم
  • عنوان البريد الإلكتروني للمستخدم
  • السلسلة الحرفية "me"، للإشارة إلى المستخدم صاحب الطلب

يجب ضبط ذلك في طلب إنشاء. يمكن للمشرفين أيضًا تحديد هذا الحقل في patch course request لنقل الملكية. وفي سياقات أخرى، يكون الحقل للقراءة فقط.

creationTime

string (Timestamp format)

تمثّل هذه السمة وقت إنشاء الدورة التدريبية. يؤدي تحديد هذا الحقل في قناع تعديل الدورة التدريبية إلى حدوث خطأ.

للقراءة فقط.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

تمثّل هذه السمة وقت آخر تعديل على هذه الدورة التدريبية. يؤدي تحديد هذا الحقل في قناع تعديل الدورة التدريبية إلى حدوث خطأ.

للقراءة فقط.

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

enrollmentCode

string

رمز التسجيل الذي سيتم استخدامه عند الانضمام إلى هذه الدورة التدريبية. يؤدي تحديد هذا الحقل في قناع تعديل الدورة التدريبية إلى حدوث خطأ.

للقراءة فقط.

courseState

enum (CourseState)

تمثّل هذه السمة حالة الدورة التدريبية. وفي حال عدم تحديد الحالة، ستكون الولاية التلقائية هي PROVISIONED.

teacherGroupEmail

string

تمثّل هذه السمة عنوان البريد الإلكتروني لمجموعة Google تحتوي على جميع معلّمي الدورة التدريبية. لا تقبل هذه المجموعة تلقّي الرسائل الإلكترونية ويمكن استخدامها للحصول على الأذونات فقط.

للقراءة فقط.

courseGroupEmail

string

تمثّل هذه السمة عنوان البريد الإلكتروني لمجموعة Google تحتوي على جميع أعضاء الدورة التدريبية. لا تقبل هذه المجموعة تلقّي الرسائل الإلكترونية ويمكن استخدامها للحصول على الأذونات فقط.

للقراءة فقط.

teacherFolder

object (DriveFolder)

تشير هذه السمة إلى معلومات حول مجلد Drive تتم مشاركتها مع جميع معلّمي الدورة التدريبية.

سيتم ضبط هذا الحقل فقط لمعلّمي الدورة التدريبية ومشرفي النطاقات.

للقراءة فقط.

courseMaterialSets[]
(deprecated)

object (CourseMaterialSet)

مجموعات من المواد التي تظهر في "لمحة" في هذه الدورة التدريبية.

للقراءة فقط.

guardiansEnabled

boolean

ما إذا تم تفعيل إشعارات الأوصياء لهذه الدورة التدريبية أم لا

للقراءة فقط.

calendarId

string

رقم تعريف "تقويم Google" لتقويم يمكن لجميع أعضاء الدورة التدريبية الاطّلاع عليه، والذي يضيف إليه Classroom الأحداث الخاصة بالعمل في الدورة التدريبية والإشعارات الخاصة بها في الدورة التدريبية.

يتم إنشاء "تقويم Google" لدورة تدريبية بشكل غير متزامن عند ضبط الدورة التدريبية على "CourseState.ACTIVE" لأول مرة (في وقت الإنشاء أو عند تعديلها إلى ACTIVE من خلال واجهة المستخدم أو واجهة برمجة التطبيقات). لن تتم تعبئة معرّف التقويم إلى أن تكتمل عملية الإنشاء.

للقراءة فقط.

gradebookSettings

object (GradebookSettings)

إعدادات دفتر العلامات التي تحدّد طريقة احتساب الدرجة الإجمالية للطالب في الدورة التدريبية والمستخدمين الذين سيتم عرضها لهم.

إذن بالقراءة فقط

CourseState

تمثّل هذه السمة الحالات المحتملة التي يمكن أن تكون فيها الدورة التدريبية.

عمليات التعداد
COURSE_STATE_UNSPECIFIED ما مِن حالة للدورة التدريبية. ولن يتم استخدام هذه القيمة في أي رسالة من رسائل دورة تدريبية تم إرجاعها.
ACTIVE الدورة التدريبية نشطة.
ARCHIVED تمت أرشفة الدورة التدريبية. ولا يمكنك تعديلها إلا لتغييرها إلى حالة مختلفة.
PROVISIONED تم إنشاء الدورة التدريبية ولكن لم يتم تفعيلها بعد. يمكن الوصول إلى هذه الأداة من خلال المعلّم الأساسي ومشرفي النطاق، الذين يمكنهم تعديلها أو تغييرها إلى الحالة ACTIVE أو DECLINED. لا يمكن تغيير الدورة التدريبية إلى PROVISIONED إلا إذا كانت في الحالة DECLINED.
DECLINED تم إنشاء الدورة التدريبية ولكن تم رفضها. يمكن لمالك الدورة التدريبية ومشرفي النطاق الوصول إليها، على الرغم من أنه لن يتم عرضها في واجهة مستخدم الويب. لا يمكنك تعديل الدورة التدريبية باستثناء تغييرها إلى الحالة "PROVISIONED". لا يمكن تغيير الدورة التدريبية إلى DECLINED إلا إذا كانت في الحالة PROVISIONED.
SUSPENDED تم تعليق الدورة التدريبية. لا يمكنك تعديل الدورة التدريبية، ويمكن للمستخدم الذي حدّدته "ownerId" فقط الاطّلاع على الدورة التدريبية. ويمكن وضع هذه الدورة التدريبية في هذه الحالة إذا كان من المحتمل أن تخالف بنود الخدمة.

CourseMaterialSet

مجموعة من المواد التي تظهر في "نبذة عنا" من الدورة. قد تتضمن هذه المواد المنهج الدراسي أو الجدول الزمني أو معلومات أساسية أخرى تتعلق بالدورة التدريبية ككل.

تمثيل JSON
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
الحقول
title

string

عنوان هذه المجموعة

materials[]

object (CourseMaterial)

المواد المرفقة بهذه المجموعة

CourseMaterial

هي مادة مرفقة بدورة تدريبية كجزء من مجموعة مواد.

تمثيل JSON
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
الحقول
حقل الاتحاد material. بيانات المواد. يمكن أن يكون material واحدًا فقط مما يلي:
driveFile

object (DriveFile)

مرفق ملف Google Drive.

youTubeVideo

object (YouTubeVideo)

مرفق فيديو على YouTube

form

object (Form)

مرفق في "نماذج Google".

GradebookSettings

إعدادات دفتر العلامات لدورة تدريبية. يمكنك الاطّلاع على مقالة مركز المساعدة لمعرفة التفاصيل.

تمثيل JSON
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
الحقول
calculationType

enum (CalculationType)

يشير إلى كيفية حساب الدرجة الإجمالية.

displaySetting

enum (DisplaySetting)

يشير إلى من يمكنه الاطّلاع على الدرجة الإجمالية.

gradeCategories[]

object (GradeCategory)

فئات الدرجات المتاحة للمهام الدراسية في الدورة التدريبية.

CalculationType

الطرق الممكنة لحساب الدرجة الكلية.

عمليات التعداد
CALCULATION_TYPE_UNSPECIFIED لم يتم تحديد طريقة. ولا يتم إرجاعها مطلقًا.
TOTAL_POINTS الدرجة الإجمالية هي مجموع الدرجات مقسومًا على مجموع النقاط الإجمالية بغض النظر عن الفئة.
WEIGHTED_CATEGORIES الدرجة الإجمالية هي المتوسط المرجح حسب الفئة.

DisplaySetting

الإعدادات المحتملة لعرض الدرجة الإجمالية.

عمليات التعداد
DISPLAY_SETTING_UNSPECIFIED لم يتم تحديد أي إعداد. ولا يتم إرجاعها مطلقًا.
SHOW_OVERALL_GRADE تعرض الدرجة الإجمالية في دفتر العلامات والملف الشخصي للطالب لكل من المعلمين والطلاب.
HIDE_OVERALL_GRADE لا تعرِض الدرجة الإجمالية في دفتر العلامات أو الملف الشخصي للطالب
SHOW_TEACHERS_ONLY تعرِض الدرجة الإجمالية للمعلّمين في دفتر العلامات والملف الشخصي للطالب. يتم إخفاء هذه المعلومات عن الطلاب في الملف الشخصي للطالب.

الطُرق

checkAddOnCreationEligibility

تعرض هذه السياسة ما إذا كان المستخدم مؤهَّلاً لإنشاء مرفقات الإضافات في دورة تدريبية معيّنة.

checkGradingPeriodsSetupEligibility

تعرِض هذه السمة ما إذا كان المستخدِم مؤهَّلاً لتعديل GradingPeriodSettings في دورة تدريبية معيّنة.

create

تنشئ دورة تدريبية.

delete

يؤدي هذا الإجراء إلى حذف دورة تدريبية.

get

تعرض الدورة التدريبية.

getGradingPeriodSettings

تعرض هذه السياسة إعدادات فترة وضع الدرجات في دورة تدريبية.

list

عرض قائمة بالدورات التدريبية المسموح للمستخدم الذي قدّم الطلب بعرضها، مقتصرة على الدورات التي تتطابق مع الطلب.

patch

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

update

عدِّل دورة تدريبية.

updateGradingPeriodSettings

لتعديل إعدادات فترة وضع الدرجات لدورة تدريبية