Method: courses.students.list

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

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

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

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

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

पाथ पैरामीटर

पैरामीटर
courseId

string

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

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

पैरामीटर
pageSize

integer

लौटाने के लिए आइटम की ज़्यादा से ज़्यादा संख्या. अगर जानकारी उपलब्ध नहीं है, तो डिफ़ॉल्ट वैल्यू 30 होती है या 0.

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

string

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

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

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

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

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

छात्र-छात्राओं की सूची बनाते समय जवाब दें.

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

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

object (Student)

सूची के अनुरोध से मेल खाने वाले छात्र-छात्राएं.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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