Method: courses.courseWork.getAddOnContext

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

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

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

  • ऐक्सेस गड़बड़ियों के लिए PERMISSION_DENIED.
  • INVALID_ARGUMENT, अगर अनुरोध गलत तरीके से किया गया है.
  • पहचाने गए संसाधनों में से कोई एक मौजूद न होने पर, NOT_FOUND.

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

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

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

पाथ के पैरामीटर

पैरामीटर
courseId

string

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

string

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

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

पैरामीटर
addOnToken

string

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

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

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

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

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

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

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

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

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

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

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

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