Method: userProfiles.checkUserCapability

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

अनुरोध करने वाला उपयोगकर्ता, सिर्फ़ अपने लिए उपलब्ध सुविधाओं की जांच कर सकता है.

यह तरीका, गड़बड़ी के ये कोड दिखाता है:

  • PERMISSION_DENIED अगर अनुरोध करने वाले उपयोगकर्ता को, तय किए गए उपयोगकर्ता के लिए ज़रूरी शर्तें पूरी होने की जांच करने की अनुमति नहीं है.
  • INVALID_ARGUMENT अगर अनुरोध गलत तरीके से किया गया हो.

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

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

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

पाथ पैरामीटर

पैरामीटर
userId

string

ज़रूरी है. उपयोगकर्ता का आइडेंटिफ़ायर.

अनुरोध के पैरामीटर के तौर पर तय किए जाने पर, यह आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:

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

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

पैरामीटर
capability

enum (Capability)

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

enum (PreviewVersion)

ज़रूरी नहीं. एपीआई का प्रीव्यू वर्शन.

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

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

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

उपयोगकर्ता की क्षमताओं की जांच करने पर मिला जवाब.

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

JSON के काेड में दिखाना 
{
  "capability": enum (Capability),
  "allowed": boolean
}
फ़ील्ड
capability

enum (Capability)

Classroom में शामिल सुविधा.
allowed

boolean

इससे पता चलता है कि उपयोगकर्ता को बताई गई सुविधा इस्तेमाल करने की अनुमति है या नहीं.

अनुमति के स्कोप

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

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

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

अनुमति

क्षमता को दिखाने वाला enum.

Enums
CAPABILITY_UNSPECIFIED समर्थित नहीं.
CREATE_ADD_ON_ATTACHMENT अनुरोध करने के लिए इस्तेमाल किए गए OAuth क्लाइंट आईडी के Developer Console प्रोजेक्ट से जुड़े AddOnAttachments बनाने और उनमें बदलाव करने की सुविधा.
CREATE_RUBRIC रूब्रिक बनाने और उनमें बदलाव करने की सुविधा.
UPDATE_GRADING_PERIOD_SETTINGS ग्रेडिंग पीरियड की सेटिंग में बदलाव करने की सुविधा.
CREATE_STUDENT_GROUP छात्र-छात्राओं के ग्रुप और उनके सदस्यों को बनाने और उनमें बदलाव करने की सुविधा.