Google API

ampEducator allows you to integrate with Google Workspace so that users can sign in using their Google accounts and send emails using the Gmail API. You’ll need to set up both Google Sign In and Gmail integration, which are handled within the same Google Cloud project.

Getting Started

Enable Google API

In ampEducator, go to Institution Config / General / Google API. Set Google API Enabled to Yes. This will unlock the Google Sign In and Gmail fields below.

Create Google Cloud Project

Open Google Cloud Console and sign in using a Google Workspace Admin User account.

Create a new project named something like ampEducator.

This same project will be used for configuring both Google Sign In and Google Gmail integration — do not create separate projects for each.

Once these two steps are done, you can proceed with setting up Google Sign In and Gmail below.

Google Sign In allows users to log in to ampEducator using their Google Workspace credentials. This simplifies access for staff and helps maintain secure authentication across your institution.

If you expand the Google Sign In section, you’ll see all required steps along with the specific values and URLs you need to enter.

In the Google Cloud Console, ensure your ampEducator project is selected.

From the left-hand menu, go to APIs & Services > OAuth consent screen.

Set the User Type to Internal.

Enter the following details (these values and URLs can be viewed in the Google Sign In instructions in the API section:

Application Name: ampEducator

Support Email: your admin email

Authorized Domains:

ampeducator.ca (for Canadian clients)

ampeducator.com (for others)

Application Homepage: https://[yourinstitution].ampeducator.ca

Privacy Policy: http://www.ampeducator.com/privacy.php

Terms of Service: http://www.ampeducator.com/terms.php

Save and continue through the remaining steps (no scopes are required).

Click Back to Dashboard when finished.

Step 2: Create OAuth Client ID

In the Cloud Console, go to APIs & Services > Credentials.

Click + Create Credentials and choose OAuth Client ID.

Set the Application Type to Web Application.

Name it ampEducator.

Enter the Authorized Redirect URIs (found in the Google Sign In instructions in the API section of ampEducator). It will look something like this: https://[yourinstitution].ampeducator.ca/web/public/authenticate/google

Click Create and copy the generated Client ID (you will need to paste this in ampEducator in the next step)

To find the Client Secret, click the Edit (pencil icon) next to your newly created OAuth Client ID.

Then, scroll to the Client Secret section, where you can also copy the Client Secret.

Step 3: Enter Credentials in ampEducator

In ampEducator, go to Institution Config / General / Google API.

Enter the Client ID and Client Secret

Click Save.

If configured correctly, ampEducator will confirm your Google Sign In setup is complete.

Set Up Gmail Integration

Enabling Gmail integration allows ampEducator to send and receive emails on behalf of users through the Gmail API. This setup supports tracking email activity with Prospects and Students while keeping messages tied to your school's Google Workspace-managed domain.

To begin, go to Institution Config / General / Google API and expand the Google Gmail section. It includes a step-by-step breakdown with all the necessary links, values, and fields you’ll need to complete the setup.

Step 1: Enable Gmail API in ampEducator

Enable Google Gmail to reveal additional configuration fields.

Step 2: Verify Your Domain with Google Search Console

Go to the Google Search Console.

Add a new property and choose URL Prefix.

Enter the URL found in the Google Gmail instructions in ampEducator's API section. It will look something like this: https://[yourinstitution].ampeducator.ca/web/public/email/push

Choose HTML Tag for verification and copy the meta tag. Do Not Click VERIFY yet.

Paste the tag into ampEducator’s Domain Verification Tag field under the Google Gmail section.

Click Save in ampEducator.

Return to the Search Console and click Verify.

Once verified, click Go to Property.

Step 3: Create a Service Account

In the Google Cloud Console, go to IAM & Admin > Service Accounts.

Click + Create Service Account.

Enter a name like ampEducator Email.

Click Create and Continue.

Assign the Owner role.

Skip granting user access and click Done.

Step 4: Create and Download a JSON Key

In the Google Cloud Console, go to Navigation Menu > APIs & Services > Credentials.

Locate the service account you created and click the Edit (pencil) icon next to it.

Navigate to the Keys tab.

Click Add Key > Create New Key.

Choose JSON as the key type and click Create.

The JSON file will download automatically—save this file. You’ll upload it to ampEducator later.

Step 5: Enable APIs

From the Cloud Console, go to APIs & Services > Enabled APIs & Services.

Click + ENABLE APIS AND SERVICES.

Search for and enable the following:

Gmail API

Cloud Pub/Sub API

Step 6: Enable Domain-Wide Delegation

Still in the Service Accounts section, click the name of your service account, and expand Advanced Settings.

Check Enable Domain-Wide Delegation.

Click Save.

Copy the Client ID shown on the page.

Step 7: Add API Access in Google Admin Console

Go to the Google Admin Console.

Navigate to Security > API Controls > Manage Domain-Wide Delegation.

Click Add New.

Paste the Client ID from Step 6.

For the OAuth Scopes, enter: https://mail.google.com/,https://www.googleapis.com/auth/pubsub

Click Authorize.

Step 8: Upload the JSON File to ampEducator

Go back to Institution Config / General / Google API > Google Gmail.

Upload the JSON key file you downloaded earlier.

Click Save.

Step 9: Enable Gmail for Email in ampEducator

Go to Institution Config / General / Email.

Scroll to the Email Provider dropdown, and select Gmail. Click Save to apply the changes.

Once setup is complete, each user will still need to verify their individual email address to begin sending through Gmail.

Part 3: Verify Each User's Email

Once the Gmail API integration is complete, each user must verify their email address before they can begin sending messages through Gmail in ampEducator. This ensures that emails are properly authorized and sent from their own Google Workspace account.

Steps to Verify:

Each user should log into ampEducator and navigate to UserName / User Account / Custom Email.

If the setup has not been completed yet, the Custom Email status will display as NO.

The user will enter their email address using the domain assigned to the Google Workspace Organization you have configured with your ampEducator account (e.g., [email protected]).

Then click Configure & Test.

ampEducator will send a Verification Code to the email address entered.

The user will then retrieve the code from their inbox, enter it into the field provided in ampEducator, and click Configure & Test again.

If successful, the Custom Email field will update to YES, and the Last Updated date will appear below.