Method: courses.list

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

इस तरीके से गड़बड़ी के ये कोड दिखते हैं:

  • ऐक्सेस से जुड़ी गड़बड़ियों के लिए PERMISSION_DENIED.
  • अगर क्वेरी का तर्क गलत है, तो INVALID_ARGUMENT.
  • NOT_FOUND अगर क्वेरी आर्ग्युमेंट में तय किया गया कोई उपयोगकर्ता मौजूद नहीं है.

एचटीटीपी अनुरोध

GET https://classroom.googleapis.com/v1/courses

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
studentId

string

चुने गए आइडेंटिफ़ायर वाले छात्र/छात्रा वाले कोर्स को, इस नीति के दायरे में नहीं आता. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाता है
teacherId

string

चुने गए आइडेंटिफ़ायर के साथ शिक्षक वाले कोर्स को, लौटाए जाने वाले कोर्स पर पाबंदी लगाता है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाता है
courseStates[]

enum (CourseState)

लौटाए गए कोर्स को, इनमें से किसी एक स्थिति में लागू होने से रोकता है. डिफ़ॉल्ट वैल्यू के तौर पर, ऐक्टिव, संग्रहित, प्रावधान किया गया, और अस्वीकार किया गया है.
pageSize

integer

लौटाने के लिए आइटम की ज़्यादा से ज़्यादा संख्या. शून्य या जानकारी नहीं होने का मतलब है कि सर्वर ज़्यादा से ज़्यादा वैल्यू असाइन कर सकता है.

सर्वर, तय की गई संख्या से कम नतीजे दिखा सकता है.
pageToken

string

पिछले list कॉल से मिली nextPageToken वैल्यू. इससे पता चलता है कि नतीजों का अगला पेज दिखाया जाना चाहिए.

list अनुरोध, इस टोकन में मिले अनुरोध के जैसा होना चाहिए.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

कोर्स की सूची बनाते समय जवाब दें.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
courses[]

object (Course)

ऐसे कोर्स जो सूची के अनुरोध से मेल खाते हैं.
nextPageToken

string

टोकन, जो दिखाए जाने वाले नतीजों के अगले पेज की पहचान करता है. अगर यह फ़ील्ड खाली है, तो कोई और नतीजा नहीं मिलेगा.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.