Method: courses.list

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

यह तरीका, गड़बड़ी के ये कोड दिखाता है:

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

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

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

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

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

पैरामीटर
studentId

string

इससे सिर्फ़ उन कोर्स की जानकारी मिलती है जिनमें छात्र-छात्रा का आइडेंटिफ़ायर मौजूद है. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

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

अगर यह वैल्यू दी गई है, तो teacherId की वैल्यू खाली होनी चाहिए.
teacherId

string

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

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

अगर यह वैल्यू दी गई है, तो studentId की वैल्यू खाली होनी चाहिए.
courseStates[]

enum (CourseState)

इससे, नतीजे के तौर पर सिर्फ़ उन कोर्स को दिखाया जाता है जो बताई गई किसी स्थिति में हैं. डिफ़ॉल्ट वैल्यू ACTIVE, ARCHIVED, PROVISIONED, DECLINED होती है.
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

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