REST Resource: courses.courseWork

منبع: CourseWork

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

نمایش JSON 
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "dueDate": {
    object (Date)
  },
  "dueTime": {
    object (TimeOfDay)
  },
  "scheduledTime": string,
  "maxPoints": number,
  "workType": enum (CourseWorkType),
  "associatedWithDeveloper": boolean,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "submissionModificationMode": enum (SubmissionModificationMode),
  "creatorUserId": string,
  "topicId": string,
  "gradeCategory": {
    object (GradeCategory)
  },
  "previewVersion": enum (PreviewVersion),
  "learningGoals": [
    {
      object (LearningGoal)
    }
  ],

  "assignment": {
    object (Assignment)
  },
  "multipleChoiceQuestion": {
    object (MultipleChoiceQuestion)
  }
  "gradingPeriodId": string
}
فیلدها
courseId

string

شناسه دوره.

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

string

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

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

string

عنوان این کار کلاسی. عنوان باید رشته UTF-8 معتبری باشد که بین ۱ تا ۳۰۰۰ نویسه داشته باشد.
description

string

شرح اختیاری این کار کلاسی. اگر تنظیم شده باشد، شرح باید رشته UTF-8 معتبری باشد که بیش‌از ۳۰٬۰۰۰ نویسه نداشته باشد.
materials[]

object (Material)

مطالب تکمیلی.

CourseWork نباید بیش‌از ۲۰ مورد مطالب داشته باشد.
state

enum (CourseWorkState)

وضعیت این کار کلاسی. اگر مشخص نشده باشد، وضعیت پیش‌فرض DRAFT است.
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".
dueDate

object (Date)

تاریخ اختیاری، در قالب UTC، که سررسید ارسال‌های این کار کلاسی است. اگر dueTime مشخص شده باشد، این مورد نیز باید مشخص شود.
dueTime

object (TimeOfDay)

زمان اختیاری روز، به ساعت هماهنگ جهانی (UTC)، که سررسید ارسال‌های این کار کلاسی است. اگر dueDate مشخص شده باشد، این مورد نیز باید مشخص شود.
scheduledTime

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".
maxPoints

number

حداکثر نمره برای این کار کلاسی. اگر صفر یا نامشخص باشد، این تکلیف بدون نمره درنظر گرفته می‌شود. این مقدار باید عدد صحیح غیرمنفی باشد.
workType

enum (CourseWorkType)

نوع این کار کلاسی.

نوع تکلیف هنگام ایجاد آن تنظیم می‌شود و قابل‌تغییر نیست.
associatedWithDeveloper

boolean

اینکه آیا این مورد کار کلاسی با پروژه «کنسول توسعه‌دهنده» که درخواست را ایجاد می‌کند مرتبط است یا نه.

برای جزئیات بیشتر، به courseWork.create بروید.

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

enum (AssigneeMode)

حالت فرد مکلف برای کار کلاسی. اگر مشخص نشده باشد، مقدار پیش‌فرض ALL_STUDENTS است.
individualStudentsOptions

object (IndividualStudentsOptions)

شناسه‌های محصلانی که به کار کلاسی دسترسی دارند. این فیلد فقط درصورتی تنظیم می‌شود که assigneeMode برابر با INDIVIDUAL_STUDENTS باشد. اگر assigneeMode برابر با INDIVIDUAL_STUDENTS باشد، فقط محصلین مشخص‌شده در این فیلد مکلف به انجام کار کلاسی هستند.
submissionModificationMode

enum (SubmissionModificationMode)

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

string

شناسه کاربری که کار کلاسی را ایجاد کرده است.

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

string

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

object (GradeCategory)

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

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

enum (PreviewVersion)

فقط خروجی. نسخه پیش‌نمایش میانای برنامه‌سازی کاربردی که برای بازیابی این منبع استفاده شده است.
learningGoals[]

object (LearningGoal)

اختیاری.

ارجاع به هر هدف یادگیری پیوست‌شده به این کار کلاسی. «کار کلاسی» می‌تواند حداکثر ۱۰ هدف یادگیری داشته باشد. این فیلد فقط درصورتی پر می‌شود که previewVersion مناسب تنظیم شده باشد.
جزئیات بیشتری که مختص نوعی از کار کلاسی است. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
assignment

object (Assignment)

جزئیات تکلیف. این مورد فقط زمانی درج می‌شود که workType روی ASSIGNMENT باشد.

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

object (MultipleChoiceQuestion)

جزئیات سؤال چندگزینه‌ای. برای عملیات خواندن، این فیلد فقط زمانی پر می‌شود که workType برابر با MULTIPLE_CHOICE_QUESTION باشد. برای عملیات نوشتن، این فیلد باید هنگام ایجاد کار کلاسی با workType MULTIPLE_CHOICE_QUESTION مشخص شود و درغیراین‌صورت نباید تنظیم شود.
پایان فیلدهای متقابلاً انحصاری.
gradingPeriodId

string

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

  • در زمان ایجاد، اگر مشخص نشده باشد، شناسه دوره نمره‌دهی براساس dueDate (یا scheduledTime اگر dueDate تنظیم نشده باشد) تنظیم خواهد شد.
  • برای نشان دادن اینکه هیچ ارتباطی با هیچ دوره نمره‌دهی وجود ندارد، این فیلد را روی رشته خالی («») تنظیم کنید.
  • اگر مشخص شده باشد، باید با شناسه دوره نمره‌دهی موجود در دوره مطابقت داشته باشد.

CourseWorkState

وضعیت‌های احتمالی کار کلاسی.

شمارشی‌ها
COURSE_WORK_STATE_UNSPECIFIED هیچ استانی مشخص نشده است. این مقدار هرگز برگردانده نمی‌شود.
PUBLISHED وضعیت اثری که منتشر شده است. این حالت پیش‌فرض است.
DRAFT وضعیت اثری که هنوز منتشر نشده است. تکلیف در این وضعیت فقط برای معلمان دوره و سرپرستان دامنه قابل‌مشاهده است.
DELETED وضعیت برای اثری که منتشر شده بود اما اکنون حذف شده است. تکلیف در این وضعیت فقط برای معلمان دوره و سرپرستان دامنه قابل‌مشاهده است. کار در این حالت پس‌از مدتی حذف می‌شود.

SubmissionModificationMode

حالت‌های اصلاح احتمالی برای تکالیف ارسالی محصلان.

شمارشی‌ها
SUBMISSION_MODIFICATION_MODE_UNSPECIFIED حالت اصلاح مشخص نشده است. این مقدار هرگز برگردانده نمی‌شود.
MODIFIABLE_UNTIL_TURNED_IN تکالیف ارسال‌شده را می‌توان قبل‌از واگذاری اصلاح کرد.
MODIFIABLE ارسال‌ها را می‌توان در هر زمانی اصلاح کرد.

تکلیف

جزئیات بیشتر برای تکالیف.

نمایش JSON 
{
  "studentWorkFolder": {
    object (DriveFolder)
  }
}
فیلدها
studentWorkFolder

object (DriveFolder)

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

MultipleChoiceQuestion

جزئیات بیشتر برای سؤالات چندگزینه‌ای.

نمایش JSON 
{
  "choices": [
    string
  ]
}
فیلدها
choices[]

string

انتخاب‌های ممکن.

روش‌ها

create

 کار کلاسی ایجاد می‌کند.

delete

 کار کلاسی را حذف می‌کند.

get

 تکلیف کلاسی را برمی‌گرداند.

getAddOnContext

 فراداده برافزاهای Classroom را در بافت پستی خاص دریافت می‌کند.

list

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

modifyAssignees

 حالت و گزینه‌های فرد مکلف را برای کار کلاسی تغییر می‌دهد.

patch

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