Method: courses.topics.list

उन विषयों की सूची दिखाता है जिन्हें अनुरोध करने वाले को देखने की अनुमति है.

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

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

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

GET https://classroom.googleapis.com/v1/courses/{courseId}/topics

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

पाथ पैरामीटर

पैरामीटर
courseId

string

कोर्स का आइडेंटिफ़ायर. यह आइडेंटिफ़ायर, Classroom से असाइन किया गया कोई आइडेंटिफ़ायर या alias हो सकता है.

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

पैरामीटर
pageSize

integer

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

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

string

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

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

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

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

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

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

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

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

object (Topic)

अनुरोध से मेल खाने वाले विषय आइटम.
nextPageToken

string

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

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

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

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