Method: courses.courseWork.getAddOnContext

किसी खास पोस्ट के संदर्भ में, Classroom के ऐड-ऑन का मेटाडेटा पाता है.

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

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

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

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext

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

पाथ पैरामीटर

पैरामीटर
courseId

string

ज़रूरी है. कोर्स का आइडेंटिफ़ायर.
itemId

string

उस Announcement, CourseWork या CourseWorkMaterial का आइडेंटिफ़ायर जिससे अटैचमेंट जुड़ा है. इस फ़ील्ड को भरना ज़रूरी है. हालांकि, postId से माइग्रेट करने के दौरान, इसे ज़रूरी के तौर पर मार्क नहीं किया जाता.

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

पैरामीटर
addOnToken

string

ज़रूरी नहीं. अनुरोध को अनुमति देने वाला टोकन.

जब उपयोगकर्ता को Classroom से ऐड-ऑन के यूआरएल पर रीडायरेक्ट किया जाता है, तब टोकन को क्वेरी पैरामीटर के तौर पर पास किया जाता है.

अनुमति टोकन तब ज़रूरी होता है, जब इनमें से कोई भी शर्त पूरी न हो:

  • ऐड-ऑन में पोस्ट पर अटैचमेंट हैं.
  • अनुरोध करने वाला डेवलपर प्रोजेक्ट वही है जिसने पोस्ट बनाई है.
attachmentId

string

ज़रूरी नहीं. अटैचमेंट का आइडेंटिफ़ायर. यह फ़ील्ड सभी अनुरोधों के लिए ज़रूरी है. हालांकि, जब उपयोगकर्ता अटैचमेंट डिस्कवरी iframe में हो, तब यह ज़रूरी नहीं है.

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

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

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में AddOnContext का एक इंस्टेंस शामिल किया जाता है.

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

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

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

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