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

कोर्स का नाम. उदाहरण के लिए, "10वीं कक्षा की जीव विज्ञान की किताब". नाम डालना ज़रूरी है. यह 1 से 750 वर्णों के बीच होनी चाहिए. साथ ही, यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए.
section

string

कोर्स का सेक्शन. उदाहरण के लिए, "अवधि 2". अगर इस फ़ील्ड को सेट किया जाता है, तो यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए. साथ ही, इसमें 2,800 से ज़्यादा वर्ण नहीं होने चाहिए.
descriptionHeading

string

ब्यौरे के लिए वैकल्पिक हेडिंग. उदाहरण के लिए, "दसवीं कक्षा की जीव विज्ञान की क्लास में आपका स्वागत है." अगर इस फ़ील्ड को सेट किया जाता है, तो यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए. साथ ही, इसमें 3,600 से ज़्यादा वर्ण नहीं होने चाहिए.
description

string

जानकारी देना ज़रूरी नहीं है. उदाहरण के लिए, "हम टेक्स्टबुक, मेहमान के तौर पर आए लेक्चरर, और लैब में किए जाने वाले काम के ज़रिए, जीवित प्राणियों की बनावट के बारे में जानेंगे. आपको बहुत मज़ा आने वाला है!" अगर यह फ़ील्ड सेट है, तो यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए. साथ ही, इसमें 30,000 से ज़्यादा वर्ण नहीं होने चाहिए.
room

string

कमरे की जगह की जानकारी देना ज़रूरी नहीं है. उदाहरण के लिए, "301". अगर इस फ़ील्ड को सेट किया जाता है, तो यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए. साथ ही, इसमें 650 से ज़्यादा वर्ण नहीं होने चाहिए.
ownerId

string

किसी कोर्स के मालिक का आइडेंटिफ़ायर.

create course request के पैरामीटर के तौर पर तय किए जाने पर, इस फ़ील्ड को भरना ज़रूरी है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए संख्या वाला आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जिससे अनुरोध करने वाले उपयोगकर्ता के बारे में पता चलता है

इसे क्रिएट अनुरोध में सेट किया जाना चाहिए. एडमिन, मालिकाना हक ट्रांसफ़र करने के लिए, patch course request में भी इस फ़ील्ड की जानकारी दे सकते हैं. अन्य संदर्भों में, यह सिर्फ़ पढ़ने के लिए होता है.
creationTime

string (Timestamp format)

कोर्स बनाने का समय. कोर्स अपडेट मास्क में इस फ़ील्ड को शामिल करने पर गड़बड़ी होती है.

सिर्फ़ पढ़ने के लिए.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

इस कोर्स को आखिरी बार कब अपडेट किया गया था. कोर्स अपडेट मास्क में इस फ़ील्ड को तय करने पर गड़बड़ी होती है.

सिर्फ़ पढ़ने के लिए.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "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 पर सेट किया जाता है, तो उसका कैलेंडर एसिंक्रोनस तरीके से बनाया जाता है. ऐसा कोर्स बनाते समय या यूज़र इंटरफ़ेस (यूआई) या एपीआई के ज़रिए उसे ACTIVE पर अपडेट करते समय होता है. Calendar ID तब तक नहीं दिखेगा, जब तक कैलेंडर बनाने की प्रोसेस पूरी नहीं हो जाती.

सिर्फ़ पढ़ने के लिए.
gradebookSettings

object (GradebookSettings)

ग्रेडबुक की सेटिंग से यह तय किया जाता है कि किसी छात्र या छात्रा का कोर्स के लिए कुल ग्रेड कैसे कैलकुलेट किया जाएगा और यह किसे दिखेगा.

सिर्फ़ पढ़ने के लिए.
subject

string

ज़रूरी नहीं. कोर्स का विषय.
learningStandardSettings

object (CourseLearningStandardSettings)

ज़रूरी नहीं.

कोर्स में उपलब्ध, सीखने के स्टैंडर्ड से जुड़ी सेटिंग. किसी कोर्स में ज़्यादा से ज़्यादा पांच लर्निंग स्टैंडर्ड सेट रूट असाइन किए जा सकते हैं.
levels

string

ज़रूरी नहीं. कोर्स के लेवल. उदाहरण: "नौवीं क्लास", "मिडिल स्कूल", "चौथी से पांचवीं क्लास", "केजी से दूसरी क्लास", "3000". अगर इस फ़ील्ड को सेट किया जाता है, तो यह एक मान्य UTF-8 स्ट्रिंग होनी चाहिए. साथ ही, इसमें 1,000 से कम वर्ण होने चाहिए.

इस फ़ील्ड को सिर्फ़ courses.patch तरीके का इस्तेमाल करके हटाया जा सकता है.

CourseState

किसी कोर्स की संभावित स्थितियां.

Enums
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)
  }
}
फ़ील्ड
यूनियन फ़ील्ड material. मटीरियल का डेटा. material इनमें से सिर्फ़ एक हो सकता है:
driveFile

object (DriveFile)

Google Drive में मौजूद फ़ाइल अटैच करने की सुविधा.
youTubeVideo

object (YouTubeVideo)

YouTube वीडियो अटैचमेंट.
form

object (Form)

Google Forms अटैचमेंट.

GradebookSettings

किसी कोर्स के लिए ग्रेडबुक की सेटिंग. ज़्यादा जानकारी के लिए, सहायता केंद्र का लेख पढ़ें.

JSON के काेड में दिखाना 
{
  "calculationType": enum (CalculationType),
  "displaySetting": enum (DisplaySetting),
  "gradeCategories": [
    {
      object (GradeCategory)
    }
  ]
}
फ़ील्ड
calculationType

enum (CalculationType)

इससे पता चलता है कि कुल ग्रेड का हिसाब कैसे लगाया जाता है.
displaySetting

enum (DisplaySetting)

इससे पता चलता है कि कुल ग्रेड को कौन देख सकता है..
gradeCategories[]

object (GradeCategory)

कोर्स में कोर्सवर्क के लिए उपलब्ध ग्रेड कैटगरी.

CalculationType

कुल ग्रेड कैलकुलेट करने के संभावित तरीके.

Enums
CALCULATION_TYPE_UNSPECIFIED कोई तरीका नहीं बताया गया है. इसे कभी वापस नहीं किया जाता.
TOTAL_POINTS कुल ग्रेड, ग्रेड के योग को कुल पॉइंट के योग से भाग देने पर मिलता है. इसमें कैटगरी से कोई फ़र्क़ नहीं पड़ता.
WEIGHTED_CATEGORIES कैटगरी के हिसाब से वेटेज के औसत को कुल ग्रेड कहा जाता है.

DisplaySetting

कुल ग्रेड दिखाने के लिए उपलब्ध सेटिंग.

Enums
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 GUID है.
documentTitle

string

सिर्फ़ आउटपुट के लिए. यह कुकी, लर्निंग स्टैंडर्ड सेट के रूट का दस्तावेज़ शीर्षक सेव करती है.
standardTitle

string

सिर्फ़ आउटपुट के लिए. लर्निंग स्टैंडर्ड सेट के रूट का टाइटल.
sourceDataAvailabilityStatus

enum (LearningStandardAvailabilityState)

सिर्फ़ आउटपुट के लिए. लर्निंग स्टैंडर्ड सेट के रूट की उपलब्धता की स्थिति. इसका इस्तेमाल यह पता लगाने के लिए करें कि सोर्स से लर्निंग स्टैंडर्ड सेट रूट मिटाया गया है या नहीं.

तरीके

checkAddOnCreationEligibility
(deprecated)

 इससे यह पता चलता है कि कोई उपयोगकर्ता किसी कोर्स में ऐड-ऑन अटैचमेंट बनाने की ज़रूरी शर्तें पूरी करता है या नहीं.

checkGradingPeriodsSetupEligibility
(deprecated)

 इससे यह पता चलता है कि कोई उपयोगकर्ता, किसी कोर्स में GradingPeriodSettings को अपडेट करने की ज़रूरी शर्तें पूरी करता है या नहीं.

create

 इस कुकी का इस्तेमाल कोर्स बनाने के लिए किया जाता है.

delete

 इस तरीके का इस्तेमाल करके, किसी कोर्स को मिटाया जा सकता है.

get

 यह फ़ंक्शन, कोर्स दिखाता है.

getGradingPeriodSettings

 किसी कोर्स में ग्रेडिंग पीरियड की सेटिंग दिखाता है.

list

 यह उन कोर्स की सूची दिखाता है जिन्हें अनुरोध करने वाला उपयोगकर्ता देख सकता है. हालांकि, यह सूची सिर्फ़ उन कोर्स तक सीमित होती है जो अनुरोध से मेल खाते हैं.

patch

 इस तरीके का इस्तेमाल करके, किसी कोर्स के एक या उससे ज़्यादा फ़ील्ड अपडेट किए जा सकते हैं.

update

 इस तरीके का इस्तेमाल करके, किसी कोर्स को अपडेट किया जा सकता है.

updateGradingPeriodSettings

 यह फ़ंक्शन, किसी कोर्स के ग्रेडिंग पीरियड की सेटिंग अपडेट करता है.