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

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

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

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

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

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

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

object (Topic)

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

nextPageToken

string

वापस आने वाले नतीजों के अगले पेज की पहचान करने वाला टोकन. अगर खाली है, तो और नतीजे उपलब्ध नहीं होंगे.

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

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

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

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