REST Resource: courses

منبع: دوره

یک دوره در کلاس درس

نمایندگی 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 باشد و بیش از 30000 کاراکتر نباشد.

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 تنظیم می شود (در زمان ایجاد یا زمانی که از طریق UI یا API به ACTIVE به روز می شود)، تقویم یک دوره به صورت ناهمزمان ایجاد می شود. شناسه تقویم تا زمانی که فرآیند ایجاد کامل نشود، پر نمی شود.

فقط خواندنی

gradebookSettings

object ( GradebookSettings )

تنظیمات دفترچه نمرات که مشخص می کند نمره کلی دانش آموز برای درس چگونه محاسبه می شود و به چه کسانی نمایش داده می شود.

فقط خواندنی

Course State

حالت های احتمالی که یک دوره می تواند در آنها باشد.

Enums
COURSE_STATE_UNSPECIFIED بدون حالت دوره هیچ پیام دوره برگشتی از این مقدار استفاده نخواهد کرد.
ACTIVE دوره فعال است.
ARCHIVED دوره بایگانی شده است. شما نمی توانید آن را تغییر دهید مگر اینکه آن را به حالت دیگری تغییر دهید.
PROVISIONED دوره ایجاد شده است، اما هنوز فعال نشده است. معلم اصلی و مدیران دامنه در دسترس هستند، که ممکن است آن را تغییر دهند یا به حالت ACTIVE یا DECLINED تغییر دهند. یک دوره فقط در صورتی می تواند به PROVISIONED تغییر یابد که در حالت DECLINED باشد.
DECLINED دوره ایجاد شد، اما رد شد. مالک دوره و مدیران دامنه به آن دسترسی دارند، اگرچه در رابط کاربری وب نمایش داده نخواهد شد. شما نمی توانید دوره را تغییر دهید مگر اینکه آن را به حالت PROVISIONED تغییر دهید. یک دوره فقط در صورتی می تواند به DECLINED تغییر یابد که در وضعیت PROVISIONED باشد.
SUSPENDED دوره به حالت تعلیق درآمده است. شما نمی توانید دوره را تغییر دهید و فقط کاربری که توسط ownerId شناسایی شده است می تواند دوره را مشاهده کند. اگر دوره ای به طور بالقوه شرایط خدمات را نقض کند ممکن است در این وضعیت قرار گیرد.

CourseMaterial Set

مجموعه ای از مطالب که در صفحه "درباره" دوره ظاهر می شود. این مطالب ممکن است شامل یک برنامه درسی، برنامه، یا سایر اطلاعات زمینه مربوط به دوره به طور کلی باشد.

نمایندگی JSON 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
فیلدها
title

string

عنوان این مجموعه

materials[]

object ( 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 )

پیوست ویدیوی یوتیوب.

form

object ( Form )

پیوست Google Forms.

تنظیمات کتاب نمره

تنظیمات دفترچه نمرات برای یک دوره برای جزئیات بیشتر به مقاله مرکز راهنمایی مراجعه کنید.

نمایندگی JSON 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
فیلدها
calculationType

enum ( CalculationType )

نشان می دهد که چگونه نمره کلی محاسبه می شود.

displaySetting

enum ( DisplaySetting )

نشان می دهد چه کسی می تواند نمره کلی را ببیند..

gradeCategories[]

object ( GradeCategory )

دسته بندی های درسی که برای دوره های آموزشی در دسترس هستند.

نوع محاسبه

روش های ممکن برای محاسبه نمره کلی.

Enums
CALCULATION_TYPE_UNSPECIFIED روشی مشخص نشده است. این هرگز برگردانده نمی شود.
TOTAL_POINTS نمره کلی مجموع نمرات تقسیم بر مجموع امتیازات بدون توجه به دسته بندی است.
WEIGHTED_CATEGORIES نمره کلی میانگین وزنی بر اساس دسته است.

DisplaySetting

تنظیمات ممکن برای نمایش نمره کلی.

Enums
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

 تنظیمات دوره نمره دهی یک دوره را به روز می کند.