UiPath Integrations

GSuite Application Scope

UiPath.GSuite.Activities.GSuiteApplicationScope

Handles the connection client and authentication for GSuite activities. The GSuite activities will work with the account specified inside the Application Scope. Multiple authentication types are available.

Properties

Api Key

  • ApiKey - The account API key to be used. Keep in mind that API keys are supported only by the Sheets and Calendar services, might not fulfill all user requirements, and some functionalities might be limited. This field needs to be completed only if the ApiKey authentication method is used.

Common

  • DisplayName - The display name of the activity.

Input

  • AuthenticationType - The type of authentication for the GSuite services. Currently three types of authentication are supported: ApiKey, OAuth2 Client ID, and Service Account Key. Based on the authentication type, other different fields from the activity need to be completed.
  • Services - The services for which the authentication will apply (Drive, Gmail, Sheets). More than one service can be selected and worked on within the same scope, but keep in mind that the service needs to be enabled for the specified user.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

OAuth Client ID

  • ClientID - The credential ID for the User Account. This field needs to be completed only if OAuth2 Client ID AuthenticationType is used.
  • ClientSecret - The credential secret for the User Account. This field needs to be completed only if OAuth2 Client ID AuthenticationType is used.

Service Account Key

  • KeyPath - The path to the service account file. After creating a service account on Google Cloud Platform, a Key file will be provided for download. This field needs to be completed only if Service Account Key authentication method is used.
  • KeyType - The type of service account, dependent on the type of key file generated when creating the service account. Possible options are Json or P12. For P12 type authentication, a Password and ServiceAccountEmail are also required.
  • Password - The password for the service account. This field is required only when using a P12 authentication file.
  • ServiceAccountEmail - The email address auto-generated for the service account. This field is required only when using a P12 authentication file.

Set Up

In order to use the GSuite activities, an initial setup is required on the GSuite platform, which will determine the type of authentication that will be used with the GSuite Application Scope.

Enabling APIs

Step 1 in this setup is to enable the APIs for each GSuite Service (e.g. Gmail) within your project on Google Cloud Platform. Please visit the official Google Documentation here for step-by-step instructions on how to do so.

Creating credentials

Once you've enabled the APIs, you must generate credentials that will allow your robot to access the services. To do so, navigate within your GCP project to APIs & Services > Credentials and select Create Credentials.

Credential Options

There are three authentication mechanisms available in Google services. Our GSuite connector implements all three authentication mechanism. They are:

  • Api Key
  • OAuth2 Client ID
  • Service Account Key

For more information on the differences between these methods, please visit the official Google documentation here.

ApiKey

An API key is the simplest authentication mechanism, but can be used only with Sheets activities and only allows read access to public files.

In order to use ApiKey authentication, add your generated key to the **ApiKey** field and switch **AuthenticationType** to ApiKey.

In order to use ApiKey authentication, add your generated key to the ApiKey field and switch AuthenticationType to ApiKey.

For more information on how to obtain an API key for your Google account, please follow the Creating an API key section from the official Google documentation here.

OAuth2 Client ID

OAuth2 works with all GSuite services, but is recommended for attended automation because it requires that you manually allow the robot access to your Google resources. During run-time, that is, the following permission screen will be shown by the GSuite Application Scope:

At run-time, a *Sign in with Google* prompt will appear asking for permission to access the selected services.

At run-time, a Sign in with Google prompt will appear asking for permission to access the selected services.

In order to use OAuth authentication, add your generated ID & Secret to the **ClientID** and **ClientSecret** fields and switch **AuthenticationType** to OAuthClientID.

In order to use OAuth authentication, add your generated ID & Secret to the ClientID and ClientSecret fields and switch AuthenticationType to OAuthClientID.

For more information on how to set up an OAuth Client ID for an Google account, please follow the Creating an API key section from the official Google documentation here.

For more information on the differences between these methods, please visit the official Google documentation here.

Service Account Key

Service Accounts are a special type of Google accounts that that are not tied to a user, but can assume identities or roles. To understand the benefits of using a service account and how to set one up please visit the official Google documentation here.

In order to use Service Account authentication, add the path to your generated Service Account file to the **KeyPath** field and switch **AuthenticationType** to ServiceAccountKey. If you are using p12 keys, also fill the **Password** and **ServiceAccountEmail** fields.

In order to use Service Account authentication, add the path to your generated Service Account file to the KeyPath field and switch AuthenticationType to ServiceAccountKey. If you are using p12 keys, also fill the Password and ServiceAccountEmail fields.






  • Use of the software developed and provided by UiPath in connection with any Google software is subject to the UiPath Open Platform Activity License Agreement. Google software and services used in conjunction with the UiPath software may be accessed and used in accordance with Google Terms and any other applicable agreements, policies or guidelines as made available by Google.