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)
  }
}
फ़ील्ड
id

string

Classroom से असाइन किया गया, इस कोर्स का आइडेंटिफ़ायर.

creating a course होने पर, इसका दूसरा ईमेल पता बनाने के अनुरोध में, इस आइडेंटिफ़ायर को alias string पर सेट किया जा सकता है. id को अब भी Classroom में असाइन किया गया है और कोर्स बनाए जाने के बाद, इसे अपडेट नहीं किया जा सकता.

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

string

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

string

कोर्स का सेक्शन. उदाहरण के लिए, "दूसरी अवधि". अगर यह फ़ील्ड सेट किया जाता है, तो यह एक मान्य 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 यूटीसी के "ज़ुलू" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंक हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

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

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

आरएफ़सी3339 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों के साथ. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
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)

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

रीड-ओनली

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 के काेड में दिखाना 
{

  // Union field material can be only one of the following:
  "driveFile": {
    object (DriveFile)
  },
  "youTubeVideo": {
    object (YouTubeVideo)
  },
  "link": {
    object (Link)
  },
  "form": {
    object (Form)
  }
  // End of list of possible types for union field material.
}
फ़ील्ड
यूनियन फ़ील्ड 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 ग्रेडबुक और छात्र-छात्राओं की प्रोफ़ाइल में, शिक्षकों को कुल ग्रेड दिखाता है. छात्र-छात्राओं की प्रोफ़ाइल में उन्हें छात्र-छात्राओं से छिपाता है.

तरीके

checkAddOnCreationEligibility
(deprecated)

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

checkGradingPeriodsSetupEligibility
(deprecated)

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

create

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

delete

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

get

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

getGradingPeriodSettings

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

list

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

patch

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

update

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

updateGradingPeriodSettings

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