Method: courses.courseWork.getAddOnContext

• طلب HTTP
• مَعلمات المسار
• معامِلات طلب البحث
• نص الطلب
• نص الاستجابة
• نطاقات التفويض

الحصول على البيانات الوصفية لإضافات Classroom في سياق مشاركة محدّدة

للحفاظ على سلامة نموذج البيانات والأذونات، يجب استدعاء الإضافة لهذا الإجراء للتحقّق من صحة معلَمات طلب البحث ودور المستخدم الذي يطلب الانضمام عندما يتم فتح الإضافة في إطار iframe.

تعرض هذه الطريقة رموز الخطأ التالية:

• PERMISSION_DENIED بحثًا عن أخطاء الوصول.
• INVALID_ARGUMENT إذا كان الطلب مكتوبًا بشكلٍ غير صحيح.
• NOT_FOUND إذا لم يكن أحد الموارد التي تم تحديدها موجودًا.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المَعلمات
courseId	string مطلوبة. معرّف الدورة التدريبية.
itemId	string معرّف الإشعار أوcourseWork أو الدورة التدريبيةWorkMaterial الذي تم إرفاق المرفق تحته. هذا الحقل مطلوب، ولكن لم يتم وضع علامة عليه على هذا النحو أثناء نقل البيانات من "PostId" (معرّف المشاركة).

معلمات طلب البحث

المَعلمات
postId (deprecated)	string اختياريّ. تم إيقافها نهائيًا، ويمكنك استخدام itemId بدلاً منها.
addOnToken	string اختياريّ. الرمز المميّز الذي يسمح بالطلب ويتم تمرير الرمز المميّز كمَعلمة طلب بحث عند إعادة توجيه المستخدم من Classroom إلى عنوان URL للإضافة. يكون الرمز المميز للمصادقة مطلوبًا عندما لا ينطبق أي مما يلي: تتضمّن الإضافة مرفقات في المشاركة. يكون مشروع المطوّر الذي يُصدر الطلب هو المشروع نفسه الذي أنشأ المشاركة.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال AddOnContext.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، راجِع دليل التفويض.