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)
  },
  "subject": string,
  "learningStandardSettings": {
    object (CourseLearningStandardSettings)
  },
  "levels": string
}
فیلدها
id

string

شناسه این دوره که Classroom اختصاص داده است.

وقتی creating a course، می‌توانید به‌طور اختیاری این شناسه را روی alias string در درخواست تنظیم کنید تا نام مستعار متناظر ایجاد شود. id همچنان توسط Classroom واگذار می‌شود و پس‌از ایجاد دوره نمی‌توان آن را به‌روز کرد.

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

string

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

string

بخش دوره. برای مثال، «Period 2» (دوره ۲). اگر تنظیم شود، این فیلد باید رشته UTF-8 معتبر باشد و بیشتر از ۲۸۰۰ نویسه نداشته باشد.
descriptionHeading

string

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

string

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

string

مکان اتاق اختیاری. برای مثال، «۳۰۱». اگر تنظیم شود، این فیلد باید رشته UTF-8 معتبر باشد و بیشتر از ۶۵۰ نویسه نداشته باشد.
ownerId

string

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

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

  • شناسه عددی کاربر
  • نشانی ایمیل کاربر
  • رشته ثابت "me"، که نشان‌دهنده کاربر درخواست‌کننده است

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

string (Timestamp format)

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

فقط خواندنی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولیدشده همیشه Z-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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-نرمال‌سازی می‌شود و از ۰، ۳، ۶، یا ۹ رقم اعشاری استفاده می‌کند. انحراف‌های غیراز «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 تنظیم می‌شود (در زمان ایجاد یا وقتی ازطریق میانای کاربر یا API به ACTIVE به‌روز می‌شود). تا زمانی که فرایند ایجاد تکمیل نشود، شناسه تقویم پر نخواهد شد.

فقط خواندنی.
gradebookSettings

object (GradebookSettings)

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

فقط خواندنی.
subject

string

اختیاری. موضوع دوره.
learningStandardSettings

object (CourseLearningStandardSettings)

اختیاری.

تنظیمات مربوط به استانداردهای یادگیری دردسترس در دوره. هر دوره می‌تواند حداکثر ۲۰ ریشه مجموعه استاندارد یادگیری اختصاص‌داده‌شده داشته باشد.
levels

string

اختیاری. سطوح دوره. مثال: «کلاس نهم»، «مدرسه راهنمایی»، «چهارم - پنجم»، «K-2»، «۳۰۰۰». اگر تنظیم شود، این فیلد باید رشته UTF-8 معتبر و کمتر از ۱۰۰۰ نویسه باشد.

این فیلد را فقط بااستفاده از روش courses.patch می‌توان پاک کرد.

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 
{

  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
}
فیلدها
داده‌های مادی. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 نمره کلی را به معلمان در دفتر نمره و نمایه محصل نشان می‌دهد. از محصلین در نمایه محصلشان پنهان می‌شود.

CourseLearningStandardSettings

تنظیمات استاندارد یادگیری برای دوره.

نمایش JSON 
{
  "standardSets": [
    {
      object (LearningStandardSetRoot)
    }
  ]
}
فیلدها
standardSets[]

object (LearningStandardSetRoot)

الزامی. مجموعه ریشه‌های استاندارد یادگیری که بر این دوره اعمال شده است.

LearningStandardSetRoot

نشان‌دهنده ریشه مجموعه استانداردهای یادگیری انتخاب‌شده است. هنگام تنظیم اهداف یادگیری در موارد جاری‌سازی در میانای کاربری Classroom، زیرمجموعه‌های ریشه‌های انتخاب‌شده نشان داده خواهند شد.

نمایش JSON 
{
  "caseGuid": {
    object (CaseGuid)
  },
  "documentTitle": string,
  "standardTitle": string,
  "sourceDataAvailabilityStatus": enum (LearningStandardAvailabilityState)
}
فیلدها
caseGuid

object (CaseGuid)

الزامی. شناسه یکتای سراسری Satchel Rosetta Exchange برای ریشه مجموعه استاندارد یادگیری.
documentTitle

string

فقط خروجی. عنوان سند ریشه مجموعه استانداردهای یادگیری.
standardTitle

string

فقط خروجی. عنوان ریشه مجموعه استاندارد یادگیری.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

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

روش‌ها

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 برمی‌گرداند که آیا کاربر واجدشرایط به‌روزرسانی GradingPeriodSettings در دوره موردنظر است یا نه.

create

 دوره‌ای ایجاد می‌کند.

delete

 دوره را حذف می‌کند.

get

 دوره‌ای را برمی‌گرداند.

getGradingPeriodSettings

 تنظیمات دوره نمره‌دهی را در دوره برمی‌گرداند.

list

 فهرستی از دوره‌هایی را برمی‌گرداند که کاربر درخواست‌کننده مجاز به مشاهده آن‌ها است، و به مواردی که با درخواست مطابقت دارند محدود می‌شود.

patch

 یک یا چند فیلد را در دوره به‌روز می‌کند.

update

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

updateGradingPeriodSettings

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