REST Resource: courses.courseWorkMaterials

منبع: CourseWorkMaterial

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

نمایندگی JSON 
{
  "courseId": string,
  "id": string,
  "title": string,
  "description": string,
  "materials": [
    {
      object (Material)
    }
  ],
  "state": enum (CourseWorkMaterialState),
  "alternateLink": string,
  "creationTime": string,
  "updateTime": string,
  "scheduledTime": string,
  "assigneeMode": enum (AssigneeMode),
  "individualStudentsOptions": {
    object (IndividualStudentsOptions)
  },
  "creatorUserId": string,
  "topicId": string
}
فیلدها
courseId

string

شناسه دوره

فقط خواندنی

id

string

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

فقط خواندنی

title

string

عنوان مطالب کاری این دوره عنوان باید یک رشته معتبر UTF-8 حاوی 1 تا 3000 کاراکتر باشد.

description

string

توضیحات اختیاری این دوره آموزشی. متن باید یک رشته معتبر UTF-8 باشد که بیش از 30000 کاراکتر نداشته باشد.

materials[]

object ( Material )

مواد اضافی.

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

state

enum ( CourseWorkMaterialState )

وضعیت مواد کار این دوره. اگر مشخص نشده باشد، حالت پیش فرض DRAFT است.

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

scheduledTime

string ( Timestamp format)

مُهر زمانی اختیاری زمانی که این مطالب کار دوره قرار است منتشر شود.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

assigneeMode

enum ( AssigneeMode )

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

individualStudentsOptions

object ( IndividualStudentsOptions )

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

creatorUserId

string

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

فقط خواندنی

topicId

string

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

CourseWorkMaterialState

حالات احتمالی مواد کار البته

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

روش ها

create

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

delete

 مطالب کاری دوره را حذف می کند.

get

 مطالب کار دوره را برمی گرداند.

getAddOnContext

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

list

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

patch

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