Gets metadata for Classroom add-ons in the context of a specific post.
To 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.
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.
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.
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.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of AddOnContext.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-04 UTC."],[[["This method is deprecated and you should use `course.announcements`, `course.courseWork`, or `course.courseWorkMaterials` methods instead."],["It retrieves metadata for Classroom add-ons within a specific post's context, requiring validation via this method when add-ons are opened in iframes."],["You will need courseId and itemId as required path and query parameters respectively, along with optional parameters like addOnToken and attachmentId based on the specific context."],["Authorizing this request necessitates using OAuth scopes like `https://www.googleapis.com/auth/classroom.addons.student` or `https://www.googleapis.com/auth/classroom.addons.teacher`."]]],[]]