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 के लिए किया गया अनुरोध, उस अनुरोध के जैसा होना चाहिए जिससे यह टोकन मिला था.

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

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

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

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

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

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

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