Method: courses.announcements.getAddOnContext

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

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

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

  • PERMISSION_DENIED لأخطاء الوصول.
  • INVALID_ARGUMENT إذا كان الطلب غير صالح
  • NOT_FOUND إذا لم يكن أحد الموارد المحدّدة متوفّرًا

طلب HTTP

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

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

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

المعلمات
courseId

string

مطلوب. معرّف الدورة التدريبية.
itemId

string

معرّف Announcement أو CourseWork أو CourseWorkMaterial الذي تم إرفاق المرفق به هذا الحقل مطلوب، ولكن لم يتم وضع علامة عليه تشير إلى ذلك أثناء نقل البيانات من postId.

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

المعلمات
addOnToken

string

اختيارية: رمز مميّز يمنح الإذن بالطلب.

يتم تمرير الرمز المميّز كمَعلمة طلب بحث عند إعادة توجيه المستخدم من Classroom إلى عنوان URL الخاص بالإضافة.

يكون الرمز المميّز للتفويض مطلوبًا عندما لا يكون أيّ مما يلي صحيحًا:

  • تحتوي الإضافة على مرفقات في المشاركة.
  • مشروع المطوّر الذي يُصدر الطلب هو المشروع نفسه الذي تم إنشاء المشاركة من خلاله.
attachmentId

string

اختيارية: معرّف المرفق هذا الحقل مطلوب لجميع الطلبات باستثناء الحالات التي يكون فيها المستخدم في إطار iframe لميزة "اكتشاف المرفقات".

نص الطلب

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

نص الاستجابة

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

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

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

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

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.