فراداده‌های افزونه‌های Classroom را در زمینه یک پست خاص دریافت می‌کند.
برای حفظ یکپارچگی داده ها و مدل مجوزهای خود، یک افزونه باید این را فراخوانی کند تا پارامترهای پرس و جو و نقش کاربر درخواست کننده را هر زمان که افزونه در iframe باز می شود، تأیید کند.
اختیاری. منسوخ شده است، به جای آن از itemId استفاده کنید.
پارامترهای پرس و جو
پارامترها
itemId
string
شناسه Announcement ، CourseWork ، یا CourseWorkMaterial که پیوست تحت آن پیوست شده است. این فیلد الزامی است، اما زمانی که ما از postId مهاجرت می کنیم، به این صورت علامت گذاری نمی شود.
addOnToken
string
اختیاری. رمزی که درخواست را تأیید می کند.
هنگامی که کاربر از Classroom به URL افزونه هدایت می شود، این رمز به عنوان یک پارامتر پرس و جو ارسال می شود.
زمانی که هیچ یک از موارد زیر صحیح نباشد، کد مجوز لازم است:
این افزونه دارای پیوست هایی در پست است.
پروژه توسعه دهنده ای که درخواست را صادر می کند، همان پروژه ای است که پست را ایجاد کرده است.
attachmentId
string
اختیاری. شناسه پیوست. این فیلد برای همه درخواست‌ها الزامی است، به جز زمانی که کاربر در iframe کشف پیوست باشد.
درخواست بدن
بدنه درخواست باید خالی باشد.
بدن پاسخگو
در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از AddOnContext است.
تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: courses.posts.getAddOnContext\n\n| This method is deprecated; use the `course.announcements`, `course.courseWork` or `course.courseWorkMaterials` method instead.\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}/posts/{postId}/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| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\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| `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)."]]
