2024-06-19
▼ ▲ classroom.courses.courseWork.getAddOnContext
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnContext
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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.
Location: query
Type: string
attachmentId
Description: Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
Location: query
Type: string
Parameter Order:
Description: 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](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.get
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.list
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
pageSize
Description: The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.
Location: query
Type: string
Parameter Order:
Description: Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.create
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
HTTP Method: POST
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
Location: query
Type: string
Parameter Order:
Description: Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.patch
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the post under which the attachment is attached.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Required. Identifier of the post under which the attachment is attached.
Location: query
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.delete
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: DELETE
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.studentSubmissions.patch
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
submissionId
Description: Required. Identifier of the student's submission.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: * `points_earned`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. 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.
▼ ▲ classroom.courses.courseWork.addOnAttachments.studentSubmissions.get
Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Flat Path: v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
submissionId
Description: Required. Identifier of the student’s submission.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/classroom.student-submissions.students.readonly
Description: Returns a student submission for an add-on attachment. 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.
▼ ▲ classroom.courses.announcements.getAddOnContext
Path: v1/courses/{courseId}/announcements/{itemId}/addOnContext
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnContext
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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.
Location: query
Type: string
attachmentId
Description: Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
Location: query
Type: string
Parameter Order:
Description: 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](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). 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.
▼ ▲ classroom.courses.announcements.addOnAttachments.get
Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. 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.
▼ ▲ classroom.courses.announcements.addOnAttachments.list
Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
pageSize
Description: The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.
Location: query
Type: string
Parameter Order:
Description: Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.announcements.addOnAttachments.create
Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
HTTP Method: POST
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
Location: query
Type: string
Parameter Order:
Description: Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.announcements.addOnAttachments.patch
Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the post under which the attachment is attached.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Required. Identifier of the post under which the attachment is attached.
Location: query
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.announcements.addOnAttachments.delete
Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: DELETE
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWorkMaterials.getAddOnContext
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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.
Location: query
Type: string
attachmentId
Description: Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
Location: query
Type: string
Parameter Order:
Description: 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](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). 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.
▼ ▲ classroom.courses.courseWorkMaterials.addOnAttachments.get
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWorkMaterials.addOnAttachments.list
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
pageSize
Description: The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.
Location: query
Type: string
Parameter Order:
Description: Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.courseWorkMaterials.addOnAttachments.create
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
HTTP Method: POST
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
addOnToken
Description: 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. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
Location: query
Type: string
Parameter Order:
Description: Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.courseWorkMaterials.addOnAttachments.patch
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the post under which the attachment is attached.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Required. Identifier of the post under which the attachment is attached.
Location: query
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.courseWorkMaterials.addOnAttachments.delete
Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
HTTP Method: DELETE
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: query
Deprecated: Yes
Type: string
Parameter Order:
Description: Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.posts.getAddOnContext
Path: v1/courses/{courseId}/posts/{postId}/addOnContext
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnContext
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: query
Type: string
addOnToken
Description: 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.
Location: query
Type: string
attachmentId
Description: Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
Location: query
Type: string
Parameter Order:
Description: 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](https://developers.google.com/classroom/add-ons/get-started/iframes/iframes-overview). 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.
▼ ▲ classroom.courses.posts.addOnAttachments.get
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: query
Type: string
Parameter Order:
Description: Returns an add-on attachment. Requires the add-on requesting the attachment to be the original creator of the attachment. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.list
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.
Location: query
Type: string
pageSize
Description: The maximum number of attachments to return. The service may return fewer than this value. If unspecified, at most 20 attachments will be returned. The maximum value is 20; values above 20 will be coerced to 20.
Location: query
Type: integer
Format: int32
pageToken
Description: A page token, received from a previous `ListAddOnAttachments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAddOnAttachments` must match the call that provided the page token.
Location: query
Type: string
Parameter Order:
Description: Returns all attachments created by an add-on under the post. Requires the add-on to have active attachments on the post or have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.create
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments
HTTP Method: POST
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.
Location: query
Type: string
addOnToken
Description: 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. This authorization token is required for in-Classroom attachment creation but optional for partner-first attachment creation. Returns an error if not provided for partner-first attachment creation and the developer projects that created the attachment and its parent stream item do not match.
Location: query
Type: string
Parameter Order:
Description: Creates an add-on attachment under a post. Requires the add-on to have permission to create new attachments on the post. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.patch
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Required. Identifier of the post under which the attachment is attached.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
itemId
Description: Identifier of the post under which the attachment is attached.
Location: query
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachment` object. If a field that does not support empty values is included in the update mask and not set in the `AddOnAttachment` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `teacher_view_uri` * `student_view_uri` * `student_work_review_uri` * `due_date` * `due_time` * `max_points`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.delete
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
HTTP Method: DELETE
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: query
Type: string
Parameter Order:
Description: Deletes an add-on attachment. Requires the add-on to have been the original creator of the attachment. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.studentSubmissions.patch
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
HTTP Method: PATCH
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
submissionId
Description: Required. Identifier of the student's submission.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: query
Type: string
updateMask
Description: Required. Mask that identifies which fields on the attachment to update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `AddOnAttachmentStudentSubmission` object. The following fields may be specified by teachers: * `points_earned`
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Description: Updates data associated with an add-on attachment submission. Requires the add-on to have been the original creator of the attachment and the attachment to have a positive `max_points` value set. 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.
▼ ▲ classroom.courses.posts.addOnAttachments.studentSubmissions.get
Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Flat Path: v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
HTTP Method: GET
Parameters:
courseId
Description: Required. Identifier of the course.
Location: path
Required: Yes
Type: string
postId
Description: Optional. Deprecated, use item_id instead.
Location: path
Required: Yes
Type: string
attachmentId
Description: Required. Identifier of the attachment.
Location: path
Required: Yes
Type: string
submissionId
Description: Required. Identifier of the student’s submission.
Location: path
Required: Yes
Type: string
itemId
Description: 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.
Location: query
Type: string
Parameter Order:
Scopes: https://www.googleapis.com/auth/classroom.student-submissions.students.readonly
Description: Returns a student submission for an add-on attachment. 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.