Getting Started with Google Add-ons

By Jaron Pate

Last Updated May 27th, 2025

This is a proposed feature and is not yet available in production.

In this guide, we will walk through the steps to set up a Google Classroom Add-on for testing and later use with the Edlink API. You should be familiar with the Google Cloud Console to follow along. If you are not you can use the linked Google Guides along the way to help you.

Setup Test Environment

The best way to test Google Add-ons is to set up a demo domain for Google Classroom. You can do this here but this guide will also walk you through that.

Make sure you have a domain in the following format: gedu.demo.<your-domain>. Create a Google Workspace account for this domain.
Verify the domain in the Google Admin Console.
Register for Google Workspace for Education using the demo domain. This starts a two-week trial period.
Fill out this form to notify Google of your domain registration.
Then request an upgrade to Fundamentals or Teaching and Learning by filling out this form. (You will need this to install Classroom add-ons in your domain)

From here you can setup test accounts for a teacher and students. We would recommend creating at least one of each type of account for your instance. You can then sign in as the teacher, create a class, and add your student(s).

Create Your Private Test Add-on

Now we will walk through the steps to create a private test add-on for your demo domain. This will allow you to test your add-on in a controlled environment before publishing it publicly. See Google's guide here.

Login to Google Cloud Console as the admin of your new gedu.demo domain.
Create a new Google Cloud project
Configure the OAuth app and screen
- Request at least one of the following scopes:
  - https://www.googleapis.com/auth/userinfo.email
  - https://www.googleapis.com/auth/userinfo.profile
- Request all of the following Add-on specific scopes:
  - https://www.googleapis.com/auth/classroom.addons.teacher
  - https://www.googleapis.com/auth/classroom.addons.student

The classroom.addons.* scopes are deemed sensitive by Google, so you will need to submit your app for verification to be able to use them outside of your test domain, to remove the 100 user cap, and to remove the unverified warning screen.

This process can take several weeks so do it as soon as possible. You can find more information on the OAuth verification process here or submit your app for verification here.

Enable the Classroom API in your new project
- Go to the Google Classroom API Page
- Make sure you are in the right project
- Click on "Enable"
Enable the Google Workspace Marketplace SDK in your project
- Go to the Google Workspace Marketplace SDK Page
- Make sure you are in the right project
- Click on "Enable"
Set the Marketplace SDK App Configuration App Visibility to private.
Fill out the Marketplace SDK Store Listing page and click PUBLISH. After the app has been published, users in your test domain can find and install the app in the Google Workspace Marketplace or by visiting the App URL shown on the Store Listing page.