• All Files

Gmail API

The information on this page relates to the new upgraded interface of the IConduct platform. To view information about the Classic version of the user interface, follow this link.

 

Gmail is a free email service developed by Google. Users can access Gmail on the web and using third-party programs that synchronize email content. The Gmail API connector allows you to seamlessly import and export data from and to Gmail.

Setting up Gmail API in the Google Account

  1. If you don’t have a Google account, create it following the Google instruction.
  2. In the APIs & Services section, navigate to the Credentials page and click Select a project.

Credentials Window

  1. Create a new project.

New Project Button

  1. Name a new project. Click Create.

New Project Creation Window

  1. Go back to the APIs & Services section and navigate to the Library page.

Navigation Panel in the APIs & Services Section

  1. In the Search box, enter Gmail API.

Search Result

  1. Click on Gmail API and enable it.

Enabling Gmail API

  1. Create credentials for Gmail API.

The Create Credentials Button

  1. Add credentials as shown below. And click What credentials do I need?

Adding Credentials to the Project

  1. In the pop-up window, click SET UP CONSENT SCREEN.

OAuth Consent Screen Prompt

  1. Navigate to the Credentials tab, go to OAuth consent screen, enter the application name and domain name in the corresponding fields. Once done, click Save.

Application Name Field

Изображение выглядит как снимок экрана Автоматически созданное описание

Authorized Domains Field

  1. Go to Credentials and select 0Auth client ID.

Credentials Page

  1. At the Create OAuth client ID page, choose the Web application option. Then click Create.

Application Type List

  1. In the pop-up window copy Client ID and Client Secret. You will need them for a connection creation.

Client ID, Client Secret

Configuration Instructions

To configure the Gmail API connector, follow the instructions below:

  1. In the Main Menu, select Connections and press Create connection.

Accessing connections

  1. Scroll down to the Emails section and select the Gmail API item from the list.

Connector Selection Page

  1. In the Gmail work area, fill in the following fields and press Create.

Connection Details Area

Fields Description

Connection

The new connection name. Enter a connection alias here.

Is Active

Toggles connector’s activity at interface execution. Enable the checkbox to activate the connection for execution.

Cloud Agent

The LAN you are working with. Select "IConduct" for cloud systems and your corporate agent for internal systems.

Implementation Type

Defines the implementation type. Select from the drop-down list:

  • Default. IConduct scheduler works on the cloud agent set in the Cloud Agent field.
  • Java. IConduct scheduler works by sending requests to a Java agent.

Is Source

This connection entity is available as a data source for Import (writing to Schema). Enable the checkbox to ensure data import.

Is Target

This connection entity is available as a data target that receives data from schema to current data container. Enable the checkbox to ensure data export.

Timeout

The length of time (in milliseconds) the IConduct platform waits for a response from the connection provider before returning a timeout error. Set the time value to stop the system from connection attempts.

SQL

The box is intended for entering a query. You can test the defined query by clicking Test Query once the connection is saved.

It’s recommended to test the query after the connection testing.

DateTime Format

Not used in this connector.

Client ID

The field value is taken from Google account (see step 14).

Client Secret

The field value is taken from Google account (see step 14).

Important!

Paste here the Secret API key that can be obtained from the Google user account. Every web client is provided with separate keys for testing and for running live transactions. If you do not include your key when making an API request, or use one that is incorrect or outdated, Gmail returns an error.  

 

Save the Connection. Copy connection URL address, navigate to the Google account Credentials > {Specific Web client} and paste it to the field Authorized redirect URIs. Click Save.

OAuth Refresh Access Token

Serves to establish a secure connection with the end-point. The Token is valid for one connection attempt only and goes with the Client ID and Client Secret. Click the Set Refresh Token button and follow the prompts to allow IConduct access to Google account. If the authorization is successful, a valid token is returned to this field.

Click Get Credentials to receive valid Client ID and Client Secret for the Google Web Client (i.e. connection).

 

Once the connection is saved, you can test if it is successful. Press the Test Connection button. If the created connection works, you will receive a success message. 

Testing the Connection