Authentication for Google Workspace Applications

Google Workspace, formerly known as G-Suite, is a collection of business, productivity, collaboration, and education software developed and powered by Google. The most popular Google Workspace tools are Gmail, Drive, Docs, Sheets, and Slides.

Hevo allows you to use both user and service accounts to connect to Google Workspace applications.


Prerequisites


Authenticating Using User Accounts

To connect Hevo with Google Workspace applications such as Google Sheets through a user account, you must sign in to your Google account, and click Allow when Hevo asks for permission to access the data.

Click Allow


Authenticating Using Google Service Accounts

To connect to Google Workspace applications such as Google Sheets and Drive through a service account, as a user with Owner role, you must:

  • Download the key file (in JSON format), which is used to authenticate you on the application.

  • Enable the respective APIs for your Google Workspace applications in your Google Cloud project for Hevo to be able to access the resource and read the data. For example, to connect to Google Sheets, you must enable the Google Sheets and Google Drive APIs. Similarly, to connect to Google Drive, you must enable the Google Drive API. Read Enabling API access for a Google service account.

(Optional) Creating a Google service account

If you have already created a service account for your team, skip to section Enabling API access for a Google service account below to enable Hevo to access the application’s API. Else, perform the following steps to create a Google service account:

  1. Log in to your Google Cloud Platform with an Owner Role.

    Note: Click here and check your role against your name. If you are not an Owner, contact your account Owner to perform the following steps.

  2. In the left navigation menu, click IAM & Admin.

  3. Under IAM & Admin, click Service Accounts.

  4. Select the project in the drop-down at the top of the page.

  5. Click + CREATE SERVICE ACCOUNT.

    Create a service account

  6. In the Service account details page, enter a Service account name and description and click CREATE AND CONTINUE.

    Create and Continue

    The Service account ID is automatically created based on the service account name.

Enabling API access for a Google service account

For Google Workspace applications, you must enable the respective API of the application, to enable the service account to read your data.

To do this:

  1. Log in to your Google Cloud Platform console.

  2. In the left navigation pane, click APIs & Services, and then click Library.

    API Library

  3. In the API Library page, search for the API using the search box and click on it.

    Search API Library

  4. Click ENABLE to enable the API. For example, you must enable both the Google Drive API and Google Sheets API for accessing Google Sheets for a service account.

    Google Drive and Sheets API

Downloading the service account key file

Service account credentials are usually stored as a key file in JSON format. You need the key file to connect your service account to Hevo.

To download the file:

  1. Log in to your Google Cloud Platform as Owner.

  2. Navigate to the IAM, Service Accounts page.

  3. Click on the newly created service account.

  4. Navigate to the KEYS tab.

  5. Click ADD KEY, and then click Create new key.

    Create new key

  6. Select the Key type as JSON, and click CREATE. This downloads the key file.

    JSON Key file

    Note: Hevo supports only JSON format for the key file.

You need to use this key file to connect your Google Workspace applications to Hevo through the service account.


Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Aug-24-2022 NA New document.
Last updated on 24 Aug 2022

Tell us what went wrong