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

कोर्स का सेक्शन. उदाहरण के लिए, "अवधि 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)

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

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

यह RFC 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)

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

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

यह RFC 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

कोर्स के सभी सदस्यों का ईमेल पता. यह ग्रुप ईमेल स्वीकार नहीं करता है. इसका इस्तेमाल सिर्फ़ अनुमतियों के लिए किया जा सकता है.

सिर्फ़ पढ़ने के लिए.
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

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