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

تمثّل هذه السمة اسم الدورة التدريبية. على سبيل المثال، "علم الأحياء للصف العاشر". يجب إدخال الاسم. يجب أن يتراوح عدد الأحرف بين 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)

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

للقراءة فقط.

يستخدم هذا النوع RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 0 أو 3 أو 6 أو 9 أرقام كسرية. يتم أيضًا قبول الإزاحات غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

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

للقراءة فقط.

يستخدم هذا النوع RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه دائمًا Z-normalized ويستخدم 0 أو 3 أو 6 أو 9 أرقام كسرية. يتم أيضًا قبول الإزاحات غير "Z". أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".

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 من خلال واجهة المستخدم أو واجهة برمجة التطبيقات). لن يتم ملء حقل "معرّف التقويم" إلا بعد اكتمال عملية الإنشاء.

للقراءة فقط.

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

تعدِّل هذه الطريقة إعدادات فترة وضع الدرجات في إحدى الدورات التدريبية.