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

نام درس. برای مثال، «زیست‌شناسی پایه دهم». نام الزامی است. باید بین ۱ تا ۷۵۰ کاراکتر و یک رشته معتبر UTF-8 باشد.

section

string

بخشی از دوره. برای مثال، "دوره ۲". در صورت تنظیم، این فیلد باید یک رشته معتبر UTF-8 باشد و بیش از ۲۸۰۰ کاراکتر نباشد.

descriptionHeading

string

عنوان اختیاری برای توضیحات. برای مثال، «به زیست‌شناسی کلاس دهم خوش آمدید.» در صورت تنظیم، این فیلد باید یک رشته معتبر UTF-8 باشد و بیش از ۳۶۰۰ کاراکتر نباشد.

description

string

توضیحات اختیاری. برای مثال، «ما با ترکیبی از کتاب‌های درسی، سخنرانی‌های مهمان و کارهای آزمایشگاهی، در مورد ساختار موجودات زنده یاد خواهیم گرفت. منتظر هیجان باشید!» در صورت تنظیم، این فیلد باید یک رشته معتبر UTF-8 باشد و بیش از 30000 کاراکتر نباشد.

room

string

مکان اتاق اختیاری است. برای مثال، "301". در صورت تنظیم، این فیلد باید یک رشته معتبر UTF-8 باشد و بیش از 650 کاراکتر نباشد.

ownerId

string

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

وقتی به عنوان پارامتر create course request مشخص می‌شود، این فیلد الزامی است. شناسه می‌تواند یکی از موارد زیر باشد:

  • شناسه عددی برای کاربر
  • آدرس ایمیل کاربر
  • رشته‌ی تحت‌اللفظی "me" که نشان دهنده‌ی کاربر درخواست‌کننده است

این باید در درخواست ایجاد تنظیم شود. مدیران همچنین می‌توانند این فیلد را در patch course request برای انتقال مالکیت مشخص کنند. در سایر زمینه‌ها، فقط خواندنی است.

creationTime

string ( Timestamp format)

زمان ایجاد دوره. مشخص کردن این فیلد در ماسک به‌روزرسانی دوره منجر به خطا می‌شود.

فقط خواندنی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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 خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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

آدرس ایمیل یک گروه گوگل که شامل همه اساتید دوره است. این گروه ایمیل نمی‌پذیرد و فقط می‌توان از آن برای مجوزها استفاده کرد.

فقط خواندنی.

courseGroupEmail

string

آدرس ایمیل یک گروه گوگل که شامل همه اعضای دوره است. این گروه ایمیل نمی‌پذیرد و فقط می‌توان از آن برای مجوزها استفاده کرد.

فقط خواندنی.

teacherFolder

object ( DriveFolder )

اطلاعات مربوط به یک پوشه درایو که با همه معلمان دوره به اشتراک گذاشته شده است.

این فیلد فقط برای اساتید دوره و مدیران دامنه تنظیم خواهد شد.

فقط خواندنی.

courseMaterialSets[]
(deprecated)

object ( CourseMaterialSet )

مجموعه مطالبی که در صفحه «درباره» این دوره آموزشی ظاهر می‌شوند.

فقط خواندنی.

guardiansEnabled

boolean

آیا اعلان‌های سرپرست برای این دوره فعال هستند یا خیر.

فقط خواندنی.

calendarId

string

شناسه تقویم برای تقویمی که همه اعضای دوره می‌توانند آن را ببینند، که Classroom رویدادهای مربوط به کار دوره و اطلاعیه‌های دوره را به آن اضافه می‌کند.

تقویم یک دوره به صورت غیرهمزمان و زمانی ایجاد می‌شود که دوره برای اولین بار روی CourseState.ACTIVE تنظیم شود (در زمان ایجاد یا زمانی که از طریق رابط کاربری یا API به ACTIVE به‌روزرسانی می‌شود). شناسه تقویم تا زمانی که فرآیند ایجاد تکمیل نشود، پر نخواهد شد.

فقط خواندنی.

gradebookSettings

object ( GradebookSettings )

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

فقط خواندنی.

کورس‌استیت

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

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

مجموعه مواد دوره

مجموعه‌ای از مطالب که در صفحه «درباره» دوره نمایش داده می‌شود. این مطالب ممکن است شامل سرفصل‌ها، برنامه زمانی یا سایر اطلاعات پیش‌زمینه مربوط به کل دوره باشد.

نمایش 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.
}
فیلدها
فیلد Union material . داده‌های مواد. material می‌توانند فقط یکی از موارد زیر باشند:
driveFile

object ( DriveFile )

پیوست فایل گوگل درایو.

youTubeVideo

object ( YouTubeVideo )

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

form

object ( Form )

پیوست گوگل فرمز.

تنظیمات دفتر نمرات

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

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

enum ( CalculationType )

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

displaySetting

enum ( DisplaySetting )

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

gradeCategories[]

object ( GradeCategory )

دسته بندی های نمره ای که برای تکالیف درسی در دوره موجود است.

نوع محاسبه

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

انوم‌ها
CALCULATION_TYPE_UNSPECIFIED هیچ روشی مشخص نشده است. این هرگز بازگردانده نمی‌شود.
TOTAL_POINTS نمره کل، حاصل تقسیم مجموع نمرات بر مجموع امتیازات صرف نظر از رشته تحصیلی است.
WEIGHTED_CATEGORIES نمره کلی، میانگین وزنی بر اساس دسته بندی است.

تنظیمات نمایش

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

انوم‌ها
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

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