Method: userProfiles.guardians.list

यह उन अभिभावकों की सूची दिखाता है जिन्हें देखने की अनुमति अनुरोध करने वाले उपयोगकर्ता को दी गई है. इस सूची में सिर्फ़ वही अभिभावक शामिल होते हैं जो अनुरोध से मेल खाते हैं.

अनुरोध करने वाला उपयोगकर्ता, जिन छात्र-छात्राओं के अभिभावकों को देख सकता है उनके अभिभावकों की सूची बनाने के लिए, स्टूडेंट आईडी के लिए लिटरल वर्ण - का इस्तेमाल करें.

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

  • PERMISSION_DENIED, अगर studentId के बारे में बताया गया है और अनुरोध करने वाले उपयोगकर्ता को उस छात्र/छात्रा की अभिभावक की जानकारी देखने की अनुमति नहीं है. अगर "-" को studentId के तौर पर बताया गया है और उपयोगकर्ता का डोमेन एडमिन नहीं है, अगर उस डोमेन के लिए अभिभावकों की सुविधा चालू नहीं है, अगर invitedEmailAddress फ़िल्टर को किसी ऐसे उपयोगकर्ता ने सेट किया है जो डोमेन एडमिन नहीं है या ऐक्सेस से जुड़ी दूसरी गड़बड़ियों के लिए ऐसा किया गया है.
  • INVALID_ARGUMENT अगर studentId दिया गया है, लेकिन इसके फ़ॉर्मैट की पहचान नहीं की जा सकती (यह ईमेल पता नहीं है, न ही एपीआई से studentId है, न ही me स्ट्रिंग से मिला है). अमान्य pageToken दिए जाने पर भी इसे दिखाया जा सकता है.
  • NOT_FOUND, अगर studentId के बारे में बताया गया है और इसके फ़ॉर्मैट की पहचान की जा सकती है, लेकिन Classroom के पास उस छात्र/छात्रा का कोई रिकॉर्ड नहीं है.

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

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

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

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

पैरामीटर
studentId

string

अभिभावक, जिस छात्र/छात्रा से जुड़ा है उसके हिसाब से नतीजों को फ़िल्टर करें. आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

  • उपयोगकर्ता के लिए न्यूमेरिक आइडेंटिफ़ायर
  • उपयोगकर्ता का ईमेल पता
  • स्ट्रिंग लिटरल "me", जो अनुरोध करने वाले उपयोगकर्ता को दिखाती है
  • स्ट्रिंग की लिटरल "-", जो यह बताती है कि उन सभी छात्र-छात्राओं को नतीजे दिखाए जाने चाहिए जिन्हें देखने का अनुरोध करने वाले उपयोगकर्ता के पास है.

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

पैरामीटर
invitedEmailAddress

string

नतीजों को उस ईमेल पते के हिसाब से फ़िल्टर करें जिस पर आपको न्योता भेजा गया था. इससे यह अभिभावक लिंक बन जाएगा. इस फ़िल्टर का इस्तेमाल सिर्फ़ डोमेन एडमिन कर सकते हैं.
pageToken

string

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

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

integer

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

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

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

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

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

अभिभावकों को सूची में शामिल करने पर जवाब देना.

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

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

object (Guardian)

नतीजों के इस पेज पर वे अभिभावक जो अनुरोध में बताई गई शर्तों को पूरा करते हैं.
nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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