Method: courses.posts.getAddOnContext

किसी खास पोस्ट के कॉन्टेक्स्ट के हिसाब से, Classroom ऐड-ऑन के लिए मेटाडेटा उपलब्ध कराता है.

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

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

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

GET https://classroom.googleapis.com/v1/courses/{courseId}/posts/{postId}/addOnContext

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

पाथ पैरामीटर

पैरामीटर
courseId

string

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

string

ज़रूरी नहीं. यह अब काम नहीं करता. इसके बजाय, itemId का इस्तेमाल करें.

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

पैरामीटर
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

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