تتوفّر الآن إضافات Google Classroom بشكل عام للمطوّرين. يُرجى الاطّلاع على
مستندات الإضافات للحصول على مزيد من المعلومات.
Method: courses.courseWork.getAddOnContext
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
تحصل هذه الطريقة على البيانات الوصفية لإضافات 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
معرّف Announcement أو CourseWork أو CourseWorkMaterial الذي تم إرفاق المرفق به هذا الحقل مطلوب، ولكن لم يتم وضع علامة عليه تشير إلى ذلك أثناء نقل البيانات من postId.
|
مَعلمات طلب البحث
| المعلمات |
postId
(deprecated) |
string
اختياريّ. تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام itemId بدلاً منها.
|
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
لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["# Method: courses.courseWork.getAddOnContext\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n\nGets metadata for Classroom add-ons in the context of a specific post.\n\nTo maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview).\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n| `itemId` | `string` Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n| `addOnToken` | `string` Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: - The add-on has attachments on the post. - The developer project issuing the request is the same project that created the post. |\n| `attachmentId` | `string` Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnContext](/workspace/classroom/reference/rest/v1/AddOnContext).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.addons.student`\n- `\n https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
