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

विवरण के लिए वैकल्पिक शीर्षक. उदाहरण के लिए, "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 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "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

किसी कोर्स का Calendar आईडी, जिसे सभी कोर्स के सदस्य देख सकते हैं. साथ ही, जिस 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

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

checkGradingPeriodsSetupEligibility

 यह जानकारी दिखाता है कि कोई उपयोगकर्ता, दिए गए कोर्स में GradingPeriodSettings अपडेट कर सकता है या नहीं.

create

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

delete

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

get

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

getGradingPeriodSettings

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

list

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

patch

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

update

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

updateGradingPeriodSettings

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