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

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

अनुमति

इस एट्रिब्यूट की मदद से, सुविधा के बारे में बताया जाता है.

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