Returns the addOnAttachments Resource.
Returns the studentSubmissions Resource.
Close httplib2 connections.
create(courseId, body=None, x__xgafv=None)
Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible
delete(courseId, id, x__xgafv=None)
Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.
get(courseId, id, x__xgafv=None)
Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)
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.
list(courseId, courseWorkStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.
Retrieves the next page of results.
modifyAssignees(courseId, id, body=None, x__xgafv=None)
Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist.
patch(courseId, id, body=None, updateMask=None, x__xgafv=None)
Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.
close()
Close httplib2 connections.
create(courseId, body=None, x__xgafv=None)
Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) body: object, The request body. The object takes the form of: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. }
delete(courseId, id, x__xgafv=None)
Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if no course exists with the requested ID. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) id: string, Identifier of the course work to delete. This identifier is a Classroom-assigned identifier. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } }
get(courseId, id, x__xgafv=None)
Returns course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) id: string, Identifier of the course work. (required) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. }
getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)
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. Args: courseId: string, Required. Identifier of the course. (required) 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 post_id. (required) 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](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use `item_id` instead. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Attachment-relevant metadata for Classroom add-ons in the context of a specific post. "courseId": "A String", # Immutable. Identifier of the course. "itemId": "A String", # Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. "postId": "A String", # Immutable. Deprecated, use `item_id` instead. "studentContext": { # Role-specific context if the requesting user is a student. # Add-on context corresponding to the requesting user's role as a student. Its presence implies that the requesting user is a student in the course. "submissionId": "A String", # Requesting user's submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`. }, "supportsStudentWork": True or False, # Optional. Whether the post allows the teacher to see student work and passback grades. "teacherContext": { # Role-specific context if the requesting user is a teacher. # Add-on context corresponding to the requesting user's role as a teacher. Its presence implies that the requesting user is a teacher in the course. }, }
list(courseId, courseWorkStates=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) courseWorkStates: string, Restriction on the work status to return. Only courseWork that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. (repeated) Allowed values COURSE_WORK_STATE_UNSPECIFIED - No state specified. This is never returned. PUBLISHED - Status for work that has been published. This is the default state. DRAFT - Status for work that is not yet published. Work in this state is visible only to course teachers and domain administrators. DELETED - Status for work that was published but is now deleted. Work in this state is visible only to course teachers and domain administrators. Work in this state is deleted after some time. orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported fields are `updateTime` and `dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Response when listing course work. "courseWork": [ # Course work items that match the request. { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. }, ], "nextPageToken": "A String", # Token identifying the next page of results to return. If empty, no further results are available. }
list_next()
Retrieves the next page of results. Args: previous_request: The request for the previous page. (required) previous_response: The response from the request for the previous page. (required) Returns: A request object that you can call 'execute()' on to request the next page. Returns None if there are no more items in the collection.
modifyAssignees(courseId, id, body=None, x__xgafv=None)
Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work does not exist. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) id: string, Identifier of the coursework. (required) body: object, The request body. The object takes the form of: { # Request to modify assignee mode and options of a coursework. "assigneeMode": "A String", # Mode of the coursework describing whether it will be assigned to all students or specified individual students. "modifyIndividualStudentsOptions": { # Contains fields to add or remove students from a course work or announcement where the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`. # Set which students are assigned or not assigned to the coursework. Must be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`. "addStudentIds": [ # IDs of students to be added as having access to this coursework/announcement. "A String", ], "removeStudentIds": [ # IDs of students to be removed from having access to this coursework/announcement. "A String", ], }, } x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. }
patch(courseId, id, body=None, updateMask=None, x__xgafv=None)
Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist. Args: courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required) id: string, Identifier of the course work. (required) body: object, The request body. The object takes the form of: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. } updateMask: string, Mask that identifies which fields on the course work to update. This field is required to do an 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 `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format 2 - v2 error format Returns: An object of the form: { # Course work created by a teacher for students of the course. "alternateLink": "A String", # Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only. "assigneeMode": "A String", # Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`. "assignment": { # Additional details for assignments. # Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only. "studentWorkFolder": { # Representation of a Google Drive folder. # Drive folder where attachments from student submissions are placed. This is only populated for course teachers and administrators. "alternateLink": "A String", # URL that can be used to access the Drive folder. Read-only. "id": "A String", # Drive API resource ID. "title": "A String", # Title of the Drive folder. Read-only. }, }, "associatedWithDeveloper": True or False, # Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only. "courseId": "A String", # Identifier of the course. Read-only. "creationTime": "A String", # Timestamp when this course work was created. Read-only. "creatorUserId": "A String", # Identifier for the user that created the coursework. Read-only. "description": "A String", # Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters. "dueDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, "dueTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified. "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. }, "gradeCategory": { # Details for a grade category in a course. Coursework may have zero or one grade category, and the category may be used in computing the overall grade. See the [help center article](https://support.google.com/edu/classroom/answer/9184995) for details. # The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only. "defaultGradeDenominator": 42, # Default value of denominator. Only applicable when grade calculation type is TOTAL_POINTS. "id": "A String", # ID of the grade category. "name": "A String", # Name of the grade category. "weight": 42, # The weight of the category average as part of overall average. A weight of 12.34% is represented as 123400 (100% is 1,000,000). The last two digits should always be zero since we use two decimal precision. Only applicable when grade calculation type is WEIGHTED_CATEGORIES. }, "id": "A String", # Classroom-assigned identifier of this course work, unique per course. Read-only. "individualStudentsOptions": { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework. "studentIds": [ # Identifiers for the students that have access to the coursework/announcement. "A String", ], }, "materials": [ # Additional materials. CourseWork must have no more than 20 material items. { # Material attached to course work. When creating attachments, setting the `form` field is not supported. "driveFile": { # Drive file that is used as material for course work. # Google Drive file material. "driveFile": { # Representation of a Google Drive file. # Drive file details. "alternateLink": "A String", # URL that can be used to access the Drive item. Read-only. "id": "A String", # Drive API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the Drive item. Read-only. "title": "A String", # Title of the Drive item. Read-only. }, "shareMode": "A String", # Mechanism by which students access the Drive item. }, "form": { # Google Forms item. # Google Forms material. "formUrl": "A String", # URL of the form. "responseUrl": "A String", # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only. "thumbnailUrl": "A String", # URL of a thumbnail image of the Form. Read-only. "title": "A String", # Title of the Form. Read-only. }, "link": { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response. "thumbnailUrl": "A String", # URL of a thumbnail image of the target URL. Read-only. "title": "A String", # Title of the target of the URL. Read-only. "url": "A String", # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters. }, "youtubeVideo": { # YouTube video item. # YouTube video material. "alternateLink": "A String", # URL that can be used to view the YouTube video. Read-only. "id": "A String", # YouTube API resource ID. "thumbnailUrl": "A String", # URL of a thumbnail image of the YouTube video. Read-only. "title": "A String", # Title of the YouTube video. Read-only. }, }, ], "maxPoints": 3.14, # Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value. "multipleChoiceQuestion": { # Additional details for multiple-choice questions. # Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise. "choices": [ # Possible choices. "A String", ], }, "scheduledTime": "A String", # Optional timestamp when this course work is scheduled to be published. "state": "A String", # Status of this course work. If unspecified, the default state is `DRAFT`. "submissionModificationMode": "A String", # Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. "title": "A String", # Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters. "topicId": "A String", # Identifier for the topic that this coursework is associated with. Must match an existing topic in the course. "updateTime": "A String", # Timestamp of the most recent change to this course work. Read-only. "workType": "A String", # Type of this course work. The type is set when the course work is created and cannot be changed. }