GSuite Application Scope

UiPath.GSuite.Activities.GSuiteApplicationScope

Description

Handles the connection client and authentication for Google Workspace activities. The Google Workspace activities work with the account specified in the Application Scope. Multiple authentication types are available.

Project compatibility

Windows - Legacy | Windows

Configuration

Properties

ApiKey

The property field below is required only if your AuthenticationType value is ApiKey.

• ApiKey - The account API key. You may only use the API key with the Google Sheets activities. This property supports String variables and string formatted values. If you want to use the Google Mail, Google Calendar, and/or Google Drive activities, you must select a different AuthenticationType value (see Input properties below).

Common

• DisplayName - The display name of the activity.
• ContinueOnError - If set, the remaining activities are executed if the current activity fails.
• TimeoutMS - If set, the activity times out with an exception after the set number of milliseconds.

Input

• AuthenticationType - A drop-down list that specifies the type of authentication you want to use to access Google Workspace services. The available property values are: ApiKey, OAuth2ClientID, and ServiceAccountKey. Depending on the authentication type selection, additional property fields may be required.

Misc

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

OAuth Client ID

The property fields below are required only if your AuthenticationType value is OAuth2ClientID.

• ClientID - The credential ID for the user account. This property supports String variables and string formatted values.
• ClientSecret - The credential secret for the user account. This property supports String variables and string formatted values.
• OAuthClient - Indicates the application (client) to be used. If UiPath is selected, no ClientID and ClientSecret should be provided. The default value is UiPath.

• SecureClientSecret - The Client secret for the User Account, as a secure string. This property supports String variables and string formatted values.

  Note:

  When you use UiPath Apps, you allow UiPath Robots to access the data inside your Google mail account. Subsequently, you allow UiPath Robots to manipulate the data solely in accordance with your instructions. UiPath will never access, store, or process in any manner the data that you manipulate with the use of UiPath Robots and will not allow for the Robots to be used outside the user's instructions. UiPath’s use of information received from Google APIs will adhere to the Google API Services User Data Policy, including the Limited Use requirements.

  You can see the full UiPath Privacy Policy for more information.

Options

• DataStoreLocation - A drop-down list that specifies where the TokenResponse gets stored. The available property values are Local disk, Orchestrator, or Never store.

  • This property is only applicable if the selected AuthenticationType is OAuthClientID.

• Folder - The Orchestrator folder where the operations occur. Leave empty if Modern folders are not enabled.

  • For more information, see About Folders in the Orchestrator Guide.

• User - The identifier assigned to an authorized user. A unique response token is generated for each identifier that can be stored for future use. This property supports String variables and string formatted values.

  • This property is only applicable if the selected AuthenticationType is OAuthClientID.

Service Account Key

The property fields below are required only if your AuthenticationType value is ServiceAccountKey.

• HasDomainWideAccess - If checked, the activity grants domain-wide access to the service account.
• KeyPath - The path to the service account key file. This property supports String variables and string formatted values. The creation of a service account on the Google Cloud Platform generates a key file for download.
• KeyType - A drop-down list that specifies the service account type according to the key file.The available property values are JSON or P12. For a P12 service account type, the Password and ServiceAccountEmail properties are required.
• Password - The password for the service account. This property supports String variables and string formatted values and is required only if your KeyType value is P12.
• ServiceAccountEmail - The auto-generated email address for the service account. This property supports String variables and string formatted values and is required only if your KeyType value is P12.
• UserEmail - If HasDomainWideAccess is checked, the service account impersonates a user from the domain; use this field to enter the impersonated user's email address.

Using the Configure Scopes wizard

A new function has been added to the GSuite Application Scope activity that incorporates a universal permissions selector, offering a clear picture of all the used authentication scopes.

All children activities included in the GSuite Application Scope activity are automatically detected as required scopes.

Note: If no scopes are manually selected from the Configure Scopes wizard, then at runtime the Auto-detect function is applied by default, and the need for configuring the wizard is eliminated. All the minimum required scopes are selected at runtime.

A scope can also be added manually after a children activity has been added to the GSuite Application Scope activity. Here is how you can manually add a new scope:

Note: For details regarding API scopes and permissions, see Microsoft 365 and Google Workspace Cards - API permissions and scopes.

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.