Prerequisites

All Google Workspace integrations depend on Google Cloud to configure API access, handle authentication and authorization, and manage applications. You might also need to obtain access to Google Classroom to test your integration. This guide describes how to request and configure these resources.

Set up a Google Cloud project

Key Point: You must use a Google Cloud project to manage a Google Classroom integration. You don't need to use any paid Google Cloud features to use Classroom API.

Complete the steps to get started for Google Workspace developers. These steps are required for all Google Workspace integrations.

Test accounts and domains

Key Point: While standard Gmail accounts can access Google Classroom, you will need a demo domain if you are attempting to test behaviors that only apply to Google Workspace for Education users, such as special administrator capabilities.

Demo domains are test accounts for Classroom API integrations. A demo domain represents a fictional school with a Google Workspace for Education subscription you can use for developing and testing integrations without affecting live users.

You can get a test domain to test administrator capabilities or for development with the Classroom API.

Get an administrative test domain

You can use a prebuilt demo environment if you only need to test administrator permissions of the API. This includes, for example, creating courses on behalf of teachers.

To use the prebuilt environment, join the Google Cloud Partner Advantage Program. Members receive access to the Google for Education page of Partner Advantage. This page describes how to access our prebuilt Google Workspace for Education demo environment that can be used for customer demos, product troubleshooting, feature testing, and more.

Get a developer demo domain

To make requests on behalf of teacher and student users, you need to create and manage your own Google Workspace for Education demo domain. Demo domains include a free, permanent Google Workspace for Education Fundamentals license. More products can be added to the domain as needed.

Complete the following steps to get a developer demo domain.

1. Purchase a domain in the format gedu.demo.YOUR DOMAIN. For example, an organization that operates the domain myedtech.com should create gedu.demo.myedtech.com. Demo domains must follow this format.

2. Sign up for Google Workspace for Education using the demo domain. This starts a two-week trial period.

   Important: The new domain must be a primary Google Workspace domain. This means that your demo domain cannot be a subdomain of an existing Google Workspace domain, which are referred to as secondary domains. Google cannot grant a demo license to a secondary domain. See the Choose your primary domain and Change your primary domain Help Center articles for more information about managing domains used for Google Workspace.
   Caution: Don't wait! Complete the following steps as soon as possible after starting the two-week trial period. We can only take action on active Google Workspace for Education subscriptions.

3. Verify that you own the demo domain.

4. Fill out this form to notify Google of your domain registration.

5. If you are developing an integration that uses paid Google Classroom features, request a demo domain upgrade.

6. Sign in to the Google Admin console using the administrator account you specified when signing up for Google Workspace for Education. From here, create new demo domain users; we recommend creating at least three additional users: one to act as teacher and two students.

7. Sign in to Google Classroom using a new teacher account. Create a new class and add your new student accounts to it.

Tip: Create separate Chrome profiles for your demo domain users so that you can quickly switch between them while using your demo domain.

Request a demo domain upgrade for premium features

Key Point: Some Google Classroom features require a paid Google Workspace for Education license. Request an upgrade for your demo domain to be able to test an integration that relies on these features.

Users must have an appropriate Google Workspace for Education license to use integrations that affect or depend on premium Classroom features. These features include:

• Classroom add-ons
• Grading periods
• Grading scales
• Grade export
• Roster sync
• Rubrics

See the Google Workspace for Education licenses page for the full list of features available at each subscription level.

If your integration will use any of these features, complete the following steps to request a demo domain upgrade. An upgraded domain will be granted ten free Google Workspace for Education Plus licenses to assign to your test users.

1. Complete the steps to get a developer demo domain if you haven't already.
2. Complete and submit the demo domain upgrade request form. Submitting this form requests that Google upgrade your demo domain to Google Workspace for Education Plus with ten licenses.
3. You will receive an email when the upgrade process is complete.
4. Assign Plus licenses to your test teacher accounts in the upgraded demo domain Admin console.
   1. Under Directory > Users, create or select your test teacher account(s).
   2. In each teacher's Licenses, confirm that Google Workspace for Education Plus is Assigned.