REST Resource: courses

संसाधन: कोर्स

Classroom में मौजूद एक कोर्स.

जेएसओएन के काेड में दिखाना 
{
  "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)

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

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

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

string (Timestamp format)

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "title": string,
  "materials": [
    {
      object (CourseMaterial)
    }
  ]
}
फ़ील्ड
title

string

इस सेट का टाइटल.
materials[]

object (CourseMaterial)

इस सेट में अटैच की गई मटीरियल.

CourseMaterial

एक मटीरियल सेट के हिस्से के रूप में कोर्स से जोड़ा गया मटीरियल.

जेएसओएन के काेड में दिखाना 
{

  // 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

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

जेएसओएन के काेड में दिखाना 
{
  "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

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

create

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

delete

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

get

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

list

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

patch

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

update

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