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

जानकारी के लिए हेडिंग. हालांकि, यह ज़रूरी नहीं है. उदाहरण के लिए, "10वीं कक्षा की जीव विज्ञान की क्लास में आपका स्वागत है." अगर यह फ़ील्ड सेट किया गया है, तो यह एक मान्य 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 पर अपडेट करते समय किया जाता है. कैलेंडर आईडी तब तक नहीं दिखेगा, जब तक कैलेंडर बनाने की प्रोसेस पूरी नहीं हो जाती.

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

object (GradebookSettings)

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

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

string

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

object (CourseLearningStandardSettings)

ज़रूरी नहीं.

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

string

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

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

CourseState

किसी कोर्स की ये स्थितियां हो सकती हैं.

Enums
COURSE_STATE_UNSPECIFIED कोर्स की स्थिति की जानकारी नहीं है. वापस किए गए किसी भी Course मैसेज में इस वैल्यू का इस्तेमाल नहीं किया जाएगा.
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 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 का जीयूआईडी.
documentTitle

string

सिर्फ़ आउटपुट के लिए. सीखने के स्टैंडर्ड सेट के रूट का दस्तावेज़ टाइटल.
standardTitle

string

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

enum (LearningStandardAvailabilityState)

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

तरीके

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

 यह बताता है कि किसी उपयोगकर्ता के पास, किसी कोर्स के लिए GradingPeriodSettings को अपडेट करने की अनुमति है या नहीं.

create

 कोई कोर्स बनाया जाता है.

delete

 किसी कोर्स को मिटाता है.

get

 किसी कोर्स की जानकारी दिखाता है.

getGradingPeriodSettings

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

list

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

patch

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

update

 किसी कोर्स को अपडेट करता है.

updateGradingPeriodSettings

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