किसी खास पोस्ट के कॉन्टेक्स्ट के हिसाब से, Classroom ऐड-ऑन के लिए मेटाडेटा उपलब्ध कराता है.
अपने डेटा और अनुमतियों के मॉडल को बनाए रखने के लिए, ऐड-ऑन को इसे कॉल करना चाहिए, ताकि जब भी iframe में ऐड-ऑन खोला जाए, तब क्वेरी पैरामीटर और अनुरोध करने वाले उपयोगकर्ता की भूमिका की पुष्टि की जा सके.
Announcement, CourseWork या CourseWorkMaterial का आइडेंटिफ़ायर, जिससे अटैचमेंट अटैच किया गया है. यह फ़ील्ड ज़रूरी है, लेकिन postId से माइग्रेट करते समय इसे मार्क नहीं किया जाता.
क्वेरी पैरामीटर
पैरामीटर
postId (deprecated)
string
ज़रूरी नहीं. यह अब काम नहीं करता. इसके बजाय, itemId का इस्तेमाल करें.
addOnToken
string
ज़रूरी नहीं. अनुरोध की अनुमति देने वाला टोकन.
जब उपयोगकर्ता को Classroom से ऐड-ऑन के यूआरएल पर रीडायरेक्ट किया जाता है, तो टोकन को क्वेरी पैरामीटर के तौर पर पास किया जाता है.
अनुमति वाले टोकन की ज़रूरत तब होती है, जब इनमें से कोई भी बात सही न हो:
पोस्ट पर ऐड-ऑन में अटैचमेंट हैं.
अनुरोध जारी करने वाला डेवलपर प्रोजेक्ट वही प्रोजेक्ट है जिससे पोस्ट बनाई गई थी.
attachmentId
string
ज़रूरी नहीं. अटैचमेंट का आइडेंटिफ़ायर. अगर उपयोगकर्ता अटैचमेंट डिस्कवरी iframe में मौजूद है, तो उसे छोड़कर बाकी सभी अनुरोधों के लिए यह फ़ील्ड ज़रूरी है.
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य हिस्सा
कामयाब रहने पर, जवाब के मुख्य हिस्से में AddOnContext का एक इंस्टेंस शामिल किया जाता है.
[[["समझने में आसान है","easyToUnderstand","thumb-up"],["मेरी समस्या हल हो गई","solvedMyProblem","thumb-up"],["अन्य","otherUp","thumb-up"]],[["वह जानकारी मौजूद नहीं है जो मुझे चाहिए","missingTheInformationINeed","thumb-down"],["बहुत मुश्किल है / बहुत सारे चरण हैं","tooComplicatedTooManySteps","thumb-down"],["पुराना","outOfDate","thumb-down"],["अनुवाद से जुड़ी समस्या","translationIssue","thumb-down"],["सैंपल / कोड से जुड़ी समस्या","samplesCodeIssue","thumb-down"],["अन्य","otherDown","thumb-down"]],["आखिरी बार 2024-09-05 (UTC) को अपडेट किया गया."],[[["Retrieves metadata for Classroom add-ons within a specific post, validating user roles and query parameters."],["Requires `courseId`, `itemId` as path parameters, with optional query parameters like `addOnToken` and `attachmentId`."],["Returns an `AddOnContext` object upon successful execution, providing relevant add-on information."],["May return errors like `PERMISSION_DENIED`, `INVALID_ARGUMENT`, or `NOT_FOUND` depending on the context."],["Needs authorization with either `https://www.googleapis.com/auth/classroom.addons.student` or `https://www.googleapis.com/auth/classroom.addons.teacher` scope."]]],[]]
