v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1310484273.7 KB
courses

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. This method returns the following error codes: * PERMISSION_DENIED for access errors. * INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if one of the identified resources does not exist.

get/v1/courses/{courseId}/announcements/{itemId}/addOnContext

Path parameters

courseIdstring required

Required. Identifier of the course.

itemIdstring required

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 post_id.

Query parameters

addOnTokenstring

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.

attachmentIdstring

Optional. The identifier of the attachment. This field is required for all requests except when the user is in the Attachment Discovery iframe.

postIdstring

Optional. Deprecated, use item_id instead.

Response

Successful response