Version 1.1, Dec 5, 2024.
The criteria on this page apply to all Classroom add-ons. Your add-on must meet all applicable required items to be approved for listing in the Google Workspace Marketplace and an add-on that "Works with Classroom".
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 .
Requirements
ID
Type
1.0
End-user License (if applicable)
1.1
A user-friendly message SHOULD be shown to the user when the user doesn't have a license. The message SHOULD clearly state the reason the add-on can't be used and suggest a course of action for the user to remedy the situation.
RECOMMENDED
1.3
The Google Workspace Marketplace listing for the add-on SHOULD specify details about the license and subscription requirements that may be required to use the add-on. If the add-on has a paid tier, the Marketplace listing SHOULD provide a link to a web page that offers more information about pricing or how to contact a salesperson.
RECOMMENDED
2.0
End-user sign-in
2.1
Teacherusers MUST sign in to the add-on using Google SSO.
If student users are asked to sign-in to the add-on, they MUST sign in using Google SSO.
If student users are asked to sign-in to the add-on, they MUST sign in using Google SSO.
REQUIRED
2.2
The add-on MUST use Google SSO to automatically sign a user in on subsequent visits without showing a login prompt.
When the login hint doesn't produce a match with the currently signed-in user, the add-on MUST prompt the user with a sign-in button and pass the login_hint to the auth library to filter out invalid accounts.
When the login hint doesn't produce a match with the currently signed-in user, the add-on MUST prompt the user with a sign-in button and pass the login_hint to the auth library to filter out invalid accounts.
REQUIRED
2.7
When the Classroom user is not already signed into the add-on (as determined by looking at the login hint) the add-on MUST present a 'Sign-in with Google' button for explicit user action to trigger the sign-in process.
Note: This is necessary to meet Google branding guidelines and also helps avoid pop-up blockers.
Note: This is necessary to meet Google branding guidelines and also helps avoid pop-up blockers.
REQUIRED
2.8
The add-on SHOULD display who the currently signed-in user is.
RECOMMENDED
3.0
General
3.1
REQUIRED
3.2
If a task is launched into a new tab or window from any of the iframe journeys, it SHOULD provide a user-friendly message to return to Classroom.
RECOMMENDED
3.3
The user MUST only complete the journey using an add-on workflow and not switch over to a courseWork flow or use the Classroom Share Button.
REQUIRED
3.4
Localization choice: language SHOULD be based on local preference set by the browser when available.
RECOMMENDED
3.5
If an add-on defines
maxPoints
, it MUST also set pointsEarned
when a student completes a submission using stored teacher credentials (recommended) OR when the teacher opens the submission in the Student Work Review iframe.REQUIRED
3.9
Add-ons SHOULD conform to the WCAG 2.1 level AA guidelines on accessibility. Add-on developers will self-report that this requirement is met at the time of submission and that the add-on continues to stay in conformance with future changes to the add-on.
RECOMMENDED
3.10
Any errors experienced by a user SHOULD be human-readable.
RECOMMENDED
3.11
If the
studentViewUri
, teacherViewUri
, or studentWorkViewUri
is launched from a copied assignment or copied course, the add-on MUST NOT display an error page in the iframe.REQUIRED
4.0
Attachment Discovery
4.1
If an attachment requires a student submission, the attachment MUST include a
studentWorkReviewUri
so that it is treated as an activity type and not content type attachment.REQUIRED
4.2
The Attachment Discovery iframe MUST provide a user interface that offers at least one of the following:
- Create new content to attach
- Browse, select, and attach from a content library
- Instructions to attach content from your website or other products
REQUIRED
4.3
The teacher SHOULD be able to find and access all content/activities available to the teacher.
RECOMMENDED
4.4
The teacher SHOULD be able to preview the content/activity prior to making a commitment to attach it to the assignment.
RECOMMENDED
4.5
If work is necessary by the teacher to create content/activity before it's able to be attached, that work SHOULD be completed in the iframe.
RECOMMENDED
5.0
Student View
5.1
When the
If the add-on does pop the user out of the iframe, there MUST be a message or other indication for students to return to Classroom.
studentViewUri
is launched, the add-on SHOULD NOT pop the user out of the iframe to complete a task.If the add-on does pop the user out of the iframe, there MUST be a message or other indication for students to return to Classroom.
RECOMMENDED
5.2
If an add-on activity pops out of the iframe, there SHOULD be a preview about the task in the iframe.
RECOMMENDED
5.3
If present, a button or link in the activity labeled Turn inMUST cause an API request to submit the student's work
for teacher review.
REQUIRED
6.0
Teacher View
6.1
The teacher SHOULD be able to see what the student will see when they do the assignment.
RECOMMENDED
7.0
Student Work Review
7.1
If the
studentWorkReviewUri
is launched, the add-on MUST render that student's work for teacher review within the iframe. Supplemental material may link outside of the iframe.REQUIRED
7.2
The add-on MUST NOT enable navigation between students in the
studentWorkReviewUri
view. Navigation between students MUST take place in the Classroom UI only.REQUIRED
8.0
Classroom mobile support
8.1
When the Classroom mobile app launches a
teacherViewUri
, studentViewUri
or studentWorkReviewUri
, the URL MUST either open the partner's mobile native app or partner's mobile web app, and in either case deep-link to the correct view. If the device is unsupported, a message MUST be displayed to the user to let them know it's an unsupported device and ideally, what devices are supported.REQUIRED
8.2
Student work SHOULD be able to be completed on a mobile device.
RECOMMENDED
9.0
Additional features
9.1
If teachers can paste links to your content as Link attachments, you SHOULD upgrade links to add-on attachments
.
RECOMMENDED
9.2
If you use a CourseWork integration to create assignments from outside of Classroom, you SHOULD create add-on attachments by default
for all links compatible with your add-on.
RECOMMENDED
Changelog
| Version 1.1 | Updated Dec 5, 2024 |
| 1.1, 1.3, 3.2, 3.10, 4.4, 5.2 | Changed from REQUIRED to RECOMMENDED. |
| 3.12 | Removed. |
| 5.3 | Reworded. A recent change allows add-on developers to reliably turn in student submissions using the API. |
| Version 1.0 | Updated Apr 30, 2024 |
| 1.1 | Combined 1.1 and 1.2 into a single requirement. |
| 2.1 | Combined 2.1 and 2.5 into a single requirement. |
| 2.2 | Combined 2.2, 2.3, and 2.4 into a single requirement. |
| 3.5 | Combined 3.5, 3.6, and 3.7 into a single requirement. |
| 3.10 | Added requirement that the add-on never enter into an unintelligible or unrecoverable state. |
| 3.11, 3.12 | Combined 5.5, 5.6, 6.3, 6.4, 7.5, and 7.6 into two new requirements. |
| 4.2 | Expanded the description of acceptable Attachment Discovery experiences. |
| 4.3 | Renumbered, formerly 4.2. Also changed from REQUIRED to RECOMMENDED. |
| 4.4 | Renumbered, formerly 4.3. |
| 4.5 | Renumbered, formerly 4.4. |
| 5.2 | Renumbered, formerly 5.3. |
| 5.3 | Renumbered, formerly 5.2. |
| 9.1 | Added a recommendation to upgrade pasted links to attachments. |
| 9.2 | Added a recommendation to create add-on attachments by default when creating CourseWork assignments programmatically. |
| 2.6, 3.7, 3.8, 6.2, 7.3, 7.4 | Removed. |
| Version 0.3 | Updated Nov 22, 2022 |
| 2.3 | Correction to the login hint guidance. |
| 2.4 | Incorporated a scenario where implementing hd
is
required. |
| 3.2 | Reworded "provide path". |
| 5.5, 5.6, 6.3, 6.4, 7.5, 7.6 | Added course copy required and recommended guidance for the studentViewUri
, teacherViewUri
, and studentWorkReviewUri
. |
| Version 0.2 | Updated Oct 29, 2021 |
| 1.3 | Tweaked the text to be more clear of intent. |
| 3.1 | Added "The add-on MUST adhere to the general GWM approval guidelines found on their website." |
| 3.9 | WCAG changed REQUIRED to RECOMMENDED. |
| 5.1 | Changed REQUIRED to RECOMMENDED. |
| 5.3 | Added "If the add-ons pops out of the iframe, there MUST have a preview about the task in the iframe." |
| 5.4 | Added "If the add-on pops out of the iframe, there SHOULD be a prompt for students to return to Classroom." |
| 8.1 | Added "If the device is unsupported, a message MUST be displayed to the user to let them know it's an unsupported device and ideally, what devices are supported." |
| 8.2 | Mobile student work changed from REQUIRED to RECOMMENDED. |
| Version 0.1 | Updated Sept 22, 2021 |
| Initial release. |
