Developer journey

The following is a quick overview of steps when developing a Classroom add-on.

Important: Subscribe to the Google for Education Developer Announcement group to receive updates about add-ons and Google Classroom API.

Onboarding

1. You will need test users with the Teaching & Learning or Plus editions of Google Workspace for Education. If you don't have administrator access to a Google Workspace for Education domain with either of these licenses, complete the steps to get a developer test domain and then submit our domain upgrade request form. The domain will be provisioned with 10 Google Workspace for Education Plus licenses.

2. Create a Google Cloud project. You'll use it configure your add-on, make API requests, and authenticate and authorize users. You can use also an existing Cloud project.

   Warning: Pay particular attention to the App Visibility. This setting controls whether your add-on will be accessible by end users and cannot be changed later.
   • If you set the App Visibility to public, join the Google Workspace Developer Preview Program with this Cloud project. This enables the Draft feature for the Cloud project, which is required for you to test the application. For more information, see Update your app listing with drafts.

3. Create teacher and student accounts for testing. Once the license is approved for your demo domain, assign seats to each of your test accounts.

4. Configure OAuth for your project.

5. Create a Google Workspace Marketplace listing for the demo project.

   • If you set the App Visibility to public, add the email addresses of all test users to the list of Draft testers. Choose SAVE DRAFT when finished.

6. Sign in to your demo domain as a test user. Install your add-on from the App URL in your Google Workspace Marketplace listing configuration.

Development

7. Develop the add-on and test it with your test testers.

Publishing

8. In the Google Cloud project you want to publish, ensure the following:
   1. OAuth consent screen:
      1. User Type: External
      2. Publish Status: In Production
      3. Scopes: Configure all scopes requested by the web app.
   2. Google Workspace Marketplace SDK App Configuration Screen:
      1. App Visibility: Public
      2. Listing Type: Unlisted
      3. Scopes: Configure all scopes requested by the web app.
9. Create a Google Workspace Marketplace listing for the public project. Add your test user accounts as Marketplace SDK Draft testers. Save your changes as a Draft. If you do not see the Draft option, enroll your project in the Google Workspace Developer Preview Program.
10. Update the public project with your add-on code.
11. As one of the Draft testers, install the add-on by visiting its Marketplace listing URL.
12. Submit an OAuth verification request for your public project. You will need to record a short video demonstrating the use of the add-ons scopes using one of the Draft tester accounts.
13. Publish the public add-on for Marketplace review.
14. Upon approval, change the Marketplace SDK Listing status to listed.

Required integrations

The following are required to build a Classroom add-on.

1. Google Single Sign-On

   • Google Identity Platform. Google offers a variety of authentication options.
   • Integration case studies.

   See the frictionless sign-in page for information about how to implement sign-in following best practices.

2. Submission to Google Workspace Marketplace as a Classroom add-on

3. iframe implementations

   • Attachment Discovery
   • Teacher View
   • Student View
   • Student Work Review. The Student Work Review iframe is only required if the attachment provides an activity-type attachment.

Google Workspace Marketplace

The Google Workspace Marketplace showcases enterprise applications that can be added to an entire domain or to individual Google Workspace accounts. The Marketplace is integrated with the Google Admin console so that domain administrators can quickly find, install, and authorize apps for targeted users.

Some key concepts to be familiar with are:

• OAuth behavior and requirements.
• The Google Workspace Marketplace developer documentation.
• The education section of Google Workspace Marketplace.