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 "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 أحداثًا لأعمال الدورة الدراسية والإعلانات في الدورة الدراسية.

يتم إنشاء "تقويم 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. يمكن أن تكون السمة "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

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

create

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

delete

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

get

 لعرض دورة.

list

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

patch

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

update

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