يتيح هذا الخيار الحصول على البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة.
للحفاظ على سلامة نموذج البيانات والأذونات الخاصة بها، يجب أن تستدعي الإضافة هذا الإجراء للتحقّق من صحة مَعلمات طلب البحث ودور المستخدم الذي قدّم الطلب عندما يتم فتح الإضافة في iframe.
تُرجع هذه الطريقة رموز الخطأ التالية:
PERMISSION_DENIED
بسبب أخطاء الوصول.INVALID_ARGUMENT
إذا كان الطلب غير صحيح.NOT_FOUND
في حال عدم توفُّر أحد الموارد المحدَّدة.
طلب HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
courseId |
مطلوب. تمثّل هذه السمة معرّف الدورة التدريبية. |
itemId |
تمثّل هذه السمة معرّف الإشعار أو الدورة التدريبية أو الدورة التدريبية أو مواد الدورات التدريبية التي تمّ إرفاق المرفق بموجبها. هذا الحقل مطلوب، ولكن لم يتم وضع علامة عليه لتوضيح ذلك أثناء نقل البيانات من رقم تعريف المنشور. |
معامِلات طلب البحث
المعلمات | |
---|---|
addOnToken |
اختياريّ. الرمز المميز الذي يخوّل الطلب. يتم تمرير الرمز المميّز كمَعلمة طلب بحث عند إعادة توجيه المستخدم من Classroom إلى عنوان URL الخاص بالإضافة. يكون الرمز المميز للمصادقة مطلوبًا في الحالات التالية:
|
attachmentId |
اختياريّ. معرّف المرفق. يجب ملء هذا الحقل لجميع الطلبات باستثناء الحالات التي يكون فيها المستخدم في إطار iframe لاكتشاف المرفقات. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال AddOnContext
.
نطاقات الأذونات
يتطلب هذا الإعداد أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.