Hiện tại, các nhà phát triển đã có thể sử dụng rộng rãi tiện ích bổ sung của Google Lớp học! Vui lòng xem tài liệu về tiện ích bổ sung để biết thêm thông tin.
Lấy siêu dữ liệu cho các tiện ích bổ sung của Lớp học trong ngữ cảnh của một bài đăng cụ thể.
Để duy trì tính toàn vẹn của dữ liệu và mô hình quyền riêng tư, tiện ích bổ sung phải gọi phương thức này để xác thực các tham số truy vấn và vai trò của người dùng yêu cầu bất cứ khi nào tiện ích bổ sung được mở trong iframe.
Không bắt buộc. Không dùng nữa, hãy sử dụng itemId.
Tham số truy vấn
Thông số
itemId
string
Giá trị nhận dạng của Announcement, CourseWork hoặc CourseWorkMaterial trong đó tệp đính kèm được đính kèm. Đây là trường bắt buộc, nhưng không được đánh dấu là bắt buộc trong khi chúng tôi di chuyển từ postId.
addOnToken
string
Không bắt buộc. Mã thông báo uỷ quyền cho yêu cầu.
Mã thông báo được truyền dưới dạng tham số truy vấn khi người dùng được chuyển hướng từ Lớp học sang URL của tiện ích bổ sung.
Mã thông báo uỷ quyền là bắt buộc khi không có điều kiện nào sau đây là đúng:
Tiện ích bổ sung có tệp đính kèm trên bài đăng.
Dự án nhà phát triển đưa ra yêu cầu là chính dự án đã tạo bài đăng.
attachmentId
string
Không bắt buộc. Giá trị nhận dạng của tệp đính kèm. Trường này là bắt buộc đối với tất cả các yêu cầu, ngoại trừ khi người dùng đang ở trong iframe Khám phá tệp đính kèm.
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của AddOnContext.
[null,null,["Cập nhật lần gần đây nhất: 2025-07-25 UTC."],[],[],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)."]]
