Developer journey

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

Onboarding phase

  1. Subscribe to the Classroom Developer Announcement group to receive updates about add-ons and Google Classroom API.
  2. Register a demo domain or subdomain that to use for private development.
  3. Verify your demo domain ownership.
  4. Sign-up for Google Workspace for Education using the demo domain.
  5. Create a private Google Cloud project for developing. Configure the app visibility to private and unlisted. This is the Google Cloud project your team uses during development.
  6. Submit the Google for Education Demo Domains form to give full licensing to your demo domain for testing.
  7. Share the demo domain and Google Cloud project ID with your Google partner. They must add the ID to an allowlist while add-ons are in Early Access.
  8. Configure OAuth for your project.
  9. Create a Google Workspace Marketplace listing for the demo project.
  10. Create teacher and student accounts for testing.
  11. Once the license is approved for your demo domain, assign seats to each of your test accounts.
  12. Sign in to your demo domain as an administrator. Install your add-on from the App URL in your Google Workspace Marketplace listing configuration.

Development phase

  1. Develop the add-on and test it.

Publishing phase

  1. Create a public Google Cloud project for publishing and 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.
  2. Create a Google Workspace Marketplace listing for the public project.
  3. Update the public project with your add-on code.
  4. Publish the public add-on for Marketplace review. Don't submit an OAuth verification request yet.
  5. The Marketplace review team creates a demo video for you to include in your OAuth verification submission.
  6. Submit OAuth verification with the demo video provided to you by the Marketplace review team.
  7. 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

    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

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: