Get

Returns a student submission

3 variables
49 variables

Returns a student submission.

  • PERMISSION_DENIED if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors.
  • INVALID_ARGUMENT if the request is malformed.
  • NOT_FOUND if the requested course, course work, or student submission does not exist

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • Manage your course work and view your grades in Google Classroom
  • View your course work and grades in Google Classroom
  • Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer
  • View course work and grades for students in the Google Classroom classes you teach or administer
  • View your course work and grades in Google Classroom
  • View course work and grades for students in the Google Classroom classes you teach or administer

Input

This building block consumes 3 input parameters

  = Parameter name
  = Format

courseId STRING Required

Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias

courseWorkId STRING Required

Identifier of the course work

id STRING Required

Identifier of the student submission

Output

This building block provides 49 output parameters

  = Parameter name
  = Format

draftGrade NUMBER

Optional pending grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places.

This is only visible to and modifiable by course teachers

late BOOLEAN

Whether this submission is late.

Read-only

courseWorkType ENUMERATION

Type of course work this submission is for.

Read-only

creationTime ANY

Creation time of this submission. This may be unset if the student has not accessed this item.

Read-only

state ENUMERATION

State of this submission.

Read-only

userId STRING

Identifier for the student that owns this submission.

Read-only

courseWorkId STRING

Identifier for the course work this corresponds to.

Read-only

courseId STRING

Identifier of the course.

Read-only

id STRING

Classroom-assigned Identifier for the student submission. This is unique among submissions for the relevant course work.

Read-only

submissionHistory[] OBJECT

The history of the submission. This currently includes state and grade histories

submissionHistory[].stateHistory OBJECT

The history of each state this submission has been in

submissionHistory[].stateHistory.stateTimestamp ANY

When the submission entered this state

submissionHistory[].stateHistory.actorUserId STRING

The teacher or student who made the change

submissionHistory[].stateHistory.state ENUMERATION

The workflow pipeline stage

submissionHistory[].gradeHistory OBJECT

The history of each grade on this submission

submissionHistory[].gradeHistory.actorUserId STRING

The teacher who made the grade change

submissionHistory[].gradeHistory.gradeTimestamp ANY

When the grade of the submission was changed

submissionHistory[].gradeHistory.gradeChangeType ENUMERATION

The type of grade change at this time in the submission grade history

submissionHistory[].gradeHistory.maxPoints NUMBER

The denominator of the grade at this time in the submission grade history

submissionHistory[].gradeHistory.pointsEarned NUMBER

The numerator of the grade at this time in the submission grade history

assignedGrade NUMBER

Optional grade. If unset, no grade was set. This value must be non-negative. Decimal (i.e. non-integer) values are allowed, but will be rounded to two decimal places.

This may be modified only by course teachers

multipleChoiceSubmission OBJECT

Student work for a multiple-choice question

multipleChoiceSubmission.answer STRING

Student's select choice

assignmentSubmission OBJECT

Student work for an assignment

assignmentSubmission.attachments[] OBJECT

Attachment added to student assignment work.

When creating attachments, setting the form field is not supported

assignmentSubmission.attachments[].driveFile OBJECT

Representation of a Google Drive file

assignmentSubmission.attachments[].driveFile.alternateLink STRING

URL that can be used to access the Drive item.

Read-only

assignmentSubmission.attachments[].driveFile.thumbnailUrl STRING

URL of a thumbnail image of the Drive item.

Read-only

assignmentSubmission.attachments[].driveFile.id STRING

Drive API resource ID

assignmentSubmission.attachments[].driveFile.title STRING

Title of the Drive item.

Read-only

assignmentSubmission.attachments[].youTubeVideo OBJECT

YouTube video item

assignmentSubmission.attachments[].youTubeVideo.thumbnailUrl STRING

URL of a thumbnail image of the YouTube video.

Read-only

assignmentSubmission.attachments[].youTubeVideo.id STRING

YouTube API resource ID

assignmentSubmission.attachments[].youTubeVideo.title STRING

Title of the YouTube video.

Read-only

assignmentSubmission.attachments[].youTubeVideo.alternateLink STRING

URL that can be used to view the YouTube video.

Read-only

assignmentSubmission.attachments[].form OBJECT

Google Forms item

assignmentSubmission.attachments[].form.responseUrl STRING

URL of the form responses document. Only set if respsonses have been recorded and only when the requesting user is an editor of the form.

Read-only

assignmentSubmission.attachments[].form.formUrl STRING

URL of the form

assignmentSubmission.attachments[].form.title STRING

Title of the Form.

Read-only

assignmentSubmission.attachments[].form.thumbnailUrl STRING

URL of a thumbnail image of the Form.

Read-only

assignmentSubmission.attachments[].link OBJECT

URL item

assignmentSubmission.attachments[].link.title STRING

Title of the target of the URL.

Read-only

assignmentSubmission.attachments[].link.thumbnailUrl STRING

URL of a thumbnail image of the target URL.

Read-only

assignmentSubmission.attachments[].link.url STRING

URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters

associatedWithDeveloper BOOLEAN

Whether this student submission is associated with the Developer Console project making the request.

See google.classroom.Work.CreateCourseWork for more details.

Read-only

shortAnswerSubmission OBJECT

Student work for a short answer question

shortAnswerSubmission.answer STRING

Student response to a short-answer question

updateTime ANY

Last update time of this submission. This may be unset if the student has not accessed this item.

Read-only

alternateLink STRING

Absolute link to the submission in the Classroom web UI.

Read-only