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 في الطلب لإنشاء اسم مستعار ملائم. لا يزال يتم تعيين id من خلال Classroom ولا يمكن تعديله بعد إنشاء الدورة التدريبية.

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

string

اسم الدورة التدريبية. على سبيل المثال، "الصف العاشر، الأحياء". يجب إدخال الاسم. يجب أن يتكوّن من بين 1 و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 "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

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

للقراءة فقط.

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقة تصل إلى نانوثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "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

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

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

للقراءة فقط.
gradebookSettings

object (GradebookSettings)

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

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

CourseState

الحالات المحتملة التي يمكن أن تكون الدورة التعليمية فيها

عمليات التعداد
COURSE_STATE_UNSPECIFIED لا تتوفّر حالة الدورة التدريبية. ولن تستخدم أي رسالة Course معروضة هذه القيمة.
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
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

 إنشاء دورة تدريبية

delete

 لحذف دورة تدريبية

get

 تعرِض دورة تدريبية.

getGradingPeriodSettings

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

list

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

patch

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

update

 تعديلات على دورة تدريبية

updateGradingPeriodSettings

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