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

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

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

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

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

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

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

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

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

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