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

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

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

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