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)

इससे, जवाब में सिर्फ़ वे कोर्स दिखते हैं जो बताई गई स्थितियों में से किसी एक में हों. अगर कोई स्थिति नहीं बताई जाती है, तो किसी भी स्थिति में मौजूद कोर्स दिखते हैं.
pageSize

integer

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

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

string

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

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

enum (PreviewVersion)

ज़रूरी नहीं. एपीआई का प्रीव्यू वर्शन. प्रीव्यू प्रोग्राम में डेवलपर के लिए उपलब्ध कराई गई, एपीआई की नई सुविधाओं को ऐक्सेस करने के लिए, इसे सेट करना ज़रूरी है.

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

कोर्स की सूची दिखाने पर मिलने वाला जवाब.

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

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

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