---
title: Google API
slug: google-api
docTags: 
createdAt: 2025-03-23T18:20:47.539Z
---

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.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/5rsmZ87CGtiOcp0DdJYlJ_screen-shot-2025-03-24-at-112209-am.png)

## 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.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/aPZz-IYPPMyPCD0GSN78M_screen-shot-2025-03-24-at-120757-pm.png)

### 
Create Google Cloud Project

Open [Google Cloud Console](https://console.developers.google.com) and sign in using a Google Workspace **Admin User** account.

1. Create a **new project** named something like *ampEducator*.
2. This same project will be used for configuring both **Google Sign In** and **Google Gmail** integration — do not create separate projects for each.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/ikJTshRegiQvMrTBB_JR2_createpic.png)

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

## Set Up Google Sign In

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.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/0CgyWNaYXP1LyMyHV0MLq_screen-shot-2025-03-24-at-122245-pm.png)

### Step 1: Configure OAuth Consent Screen

1. In the [Google Cloud Console](https://console.cloud.google.com), ensure your ampEducator project is selected.
2. From the left-hand menu, go to **APIs & Services > OAuth consent screen**.
3. Set the **User Type** to **Internal**.
4. 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
5. Save and continue through the remaining steps (no scopes are required).
6. Click **Back to Dashboard** when finished.

### Step 2: Create OAuth Client ID

1. In the Cloud Console, go to **APIs & Services > Credentials**.
2. Click **+ Create Credentials** and choose **OAuth Client ID.**

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/mS3mov1aQtRBjYAqS7tLF_oauth-client-id.png" size="100" isUploading="false" width="1868" height="537" showCaption="false" indent="2"}

3. Set the **Application Type** to **Web Application**.
4. Name it *ampEducator*.
5. 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
6. Click **Create** and copy the generated **Client ID **(you will need to paste this in ampEducator in the next step)

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/ToficuJmcazT01oQ0ucnj_copy-client-id.png" size="100" isUploading="false" width="2024" height="550" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/PXUraD3Bi0FtltAD_dM_c_clientsecretedit.png" size="100" isUploading="false" width="2020" height="648" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/TGK7YJafu8e-ldYMBnvVO_clientid2.png" size="100" isUploading="false" width="2019" height="681" showCaption="false" indent="2"}

### Step 3: Enter Credentials in ampEducator

1. In ampEducator, go to **Institution Config / General / Google API**.
2. Enter the Client ID and Client Secret

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/NvJpnwFD0MBOO20tbS46S_screen-shot-2025-03-24-at-123205-pm.png" size="100" isUploading="false" width="2082" height="640" showCaption="false" indent="2"}

3. 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.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/DTIUxvkCzyh_9yhsdaJrO_screen-shot-2025-03-24-at-123606-pm.png)

### Step 1: Enable Gmail API in ampEducator

Enable **Google Gmail** to reveal additional configuration fields.

![](https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/TzkZHvqBmShTgTClPkqPW_screen-shot-2025-03-24-at-123937-pm.png)

### Step 2: Verify Your Domain with Google Search Console

1. Go to the [Google Search Console](https://search.google.com/search-console).
2. Add a new property and choose **URL Prefix**.
3. 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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/4QFO8ndwP2gJSrJGFkOka_property-type.png" size="70" width="785" height="620" position="center" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/61Q0RCtKMGVbgg8Mu_fC-_verify-ownership.png" size="70" width="690" height="910" position="center" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/dubV6qosRqjxN63Fib4CZ_screen-shot-2025-03-28-at-33624-pm.png" size="100" isUploading="false" width="2082" height="798" showCaption="false" indent="2"}

6. Click **Save** in ampEducator.
7. Return to the Search Console and click **Verify**.
8. Once verified, click **Go to Property**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/PcL-iPvel_wFwXqViUh0k_verfieid.png" size="70" width="684" height="336" position="center" showCaption="false" indent="2"}

### Step 3: Create a Service Account

1. In the [Google Cloud Console](https://console.cloud.google.com), go to **IAM & Admin > Service Accounts**.
2. Click **+ Create Service Account**.
3. Enter a name like *ampEducator Email*.
4. Click **Create and Continue**.
5. Assign the **Owner** role.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/aGlrkkRq0wCqOfB8Q3zQI_role-owner.png" size="100" isUploading="false" width="1142" height="640" showCaption="false" indent="2"}

6. Skip granting user access and click **Done**.

### Step 4: Create and Download a JSON Key

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/Tm50BqDgzFqpsGEBBHutd_credentials.png" size="50" width="476" height="411" position="center" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/fnegVM7Xf4dP1BKuAue4E_edit-icon.png" size="100" isUploading="false" width="1082" height="548" showCaption="false" indent="2"}

3. Navigate to the **Keys** tab.
4. Click **Add Key > Create New Key**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/0jAfEC9IhJc0Zq39HZXb1_new-key.png" size="100" width="870" height="385" position="center" showCaption="false" indent="2"}

5. Choose **JSON** as the key type and click **Create**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/MgFSI4YKfhd6I7LCCdIVD_json.png" size="70" width="590" height="377" position="center" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/QMdMWjR2Ommwa7ty7b6yq_saved.png" size="100" isUploading="false" width="945" height="265" showCaption="false" indent="2"}

### Step 5: Enable APIs

1. From the Cloud Console, go to **APIs & Services > Enabled APIs & Services**.
2. Click **+ ENABLE APIS AND SERVICES**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/BpumZqR_nyTA9R4Tg46qR_screen-shot-2025-03-28-at-44837-pm.png" size="100" isUploading="false" width="2070" height="518" showCaption="false" indent="2"}

3. Search for and enable the following:
   - **Gmail API**
   - **Cloud Pub/Sub API**

### Step 6: Enable Domain-Wide Delegation

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/NDfVJPpK86JGhxns-MMpf_service-account-advanced-settings.png" size="100" isUploading="false" width="963" height="621" showCaption="false" indent="2"}

2. Check **Enable Domain-Wide Delegation**.
3. Click **Save**.
4. Copy the **Client ID** shown on the page.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/NVANlV7nl3u3woSiGEAtJ_clientid.png" size="100" isUploading="false" width="1020" height="1273" showCaption="false" indent="2"}

### Step 7: Add API Access in Google Admin Console

1. Go to the [Google Admin Console](https://admin.google.com).
2. Navigate to **Security > API Controls > Manage Domain-Wide Delegation**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/I0AViJVI2LTQriQzSnhDy_manage-domain.png" size="100" isUploading="false" width="1505" height="760" showCaption="false" indent="2"}

3. Click **Add New**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/JFkpccmT4W9Y9e69LTKh6_addnew.png" size="100" isUploading="false" width="1414" height="844" showCaption="false" indent="2"}

4. Paste the **Client ID** from Step 6.
5. For the **OAuth Scopes**, enter: https\://mail.google.com/,https\://www\.googleapis.com/auth/pubsub

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/W3yiUvBo8MnTuQiijjtBi_click-authorize.png" size="70" width="519" height="446" position="center" showCaption="false" indent="2"}

6. Click **Authorize**.

### Step 8: Upload the JSON File to ampEducator

1. Go back to **Institution Config / General / Google API > Google Gmail**.
2. Upload the JSON key file you downloaded earlier.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/MN0nUY76-L_VV1tSV6W2q_jsonamp.png" size="100" isUploading="false" width="1190" height="839" showCaption="false" indent="2"}

3. Click **Save**.

### Step 9: Enable Gmail for Email in ampEducator

1. Go to **Institution Config / General / Email.**

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/OmTZK5jsgiFc-fRxRga_q_screen-shot-2025-03-28-at-45647-pm.png" size="100" isUploading="false" width="2078" height="538" showCaption="false" indent="2"}

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

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/XPsErKIWpdytYGYGigYDP_screen-shot-2025-03-28-at-45909-pm.png" size="100" isUploading="false" width="2078" height="886" showCaption="false" indent="2"}

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:

1. Each user should log into ampEducator and navigate to **UserName / User Account / Custom Email**.
2. If the setup has not been completed yet, the **Custom Email** status will display as **NO**.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/XX4JQ0-84wU37fMamYlcZ_custom-email.png" size="68" width="528" height="176" position="center" showCaption="false" indent="2"}

3. 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., yourname\@yourschool.edu).
4. Then click **Configure & Test**.
5. ampEducator will send a **Verification Code** to the email address entered.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/wTci5oO9_2l-gqR56wm50_verification.png" size="100" isUploading="false" width="886" height="324" showCaption="false" indent="2"}

6. The user will then retrieve the code from their inbox, enter it into the field provided in ampEducator, and click **Configure & Test** again.
7. If successful, the **Custom Email** field will update to **YES**, and the **Last Updated** date will appear below.

::Image[]{src="https://api.archbee.com/api/optimize/dAaYdF15xm67t_NLKoQQv/Rb41b-SVDKsrcIM2_XZcT_configured.png" size="44" width="378" height="216" position="center" showCaption="false" indent="2"}