Method: courses.aliases.list

किसी कोर्स के उपनामों की सूची दिखाता है.

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

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
courseId

string

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

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

पैरामीटर
pageSize

integer

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

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

string

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

list के लिए किया गया अनुरोध, उस अनुरोध के जैसा होना चाहिए जिससे यह टोकन मिला था.

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

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

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

कोर्स के उपनामों की सूची बनाने पर जवाब देना.

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

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

object (CourseAlias)

कोर्स के उपनाम.
nextPageToken

string

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

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

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

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

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