- Overview
- Excel
- Release Notes
- About the Excel activity package
- Project Compatibility
- Supported character encoding
- Project Settings
- Add or Update Excel Sensitivity Label
- Append Range
- Auto Fill
- Autofit Range
- Change Pivot Data Source
- Clear Sheet/Range/Table
- Copy/Paste Range
- Create Pivot Table
- Delete Column
- Delete Rows
- Delete Sheet
- Duplicate Sheet
- Export to CSV
- Fill Range
- Filter
- Filter Pivot Table
- Find First/Last Data Row
- Find/Replace Value
- For Each Excel Row
- For Each Excel Sheet
- Format As Table
- Format Cells
- Get Cell Color
- Get Excel Chart
- Get Excel Sensitivity Label
- Get Selected Range
- Insert Column
- Insert Chart
- Insert Rows
- Insert Sheet
- Invoke VBA
- Lookup
- Match Function
- Protect Sheet
- Read Cell Formula
- Read Cell Value
- Read Range
- Refresh Excel Data Connections
- Refresh Pivot Table
- Remove Duplicates
- Rename Sheet
- Run Spreadsheet Macro
- Save Excel File
- Save Excel File As
- Save Excel File As PDF
- Select Range
- Sort Range
- Text to Columns
- Unprotect Sheet
- Update Excel Chart
- Use Excel File
- VLookup
- Write Cell
- Write CSV
- Write DataTable to Excel
- Excel Application Scope
- Append To CSV
- Read CSV
- Write CSV
- Delete Column
- Filter Table
- Get Table Range
- Insert Column
- Sort Table
- Append Range
- Close Workbook
- Get Cell Color
- Read Cell
- Read Cell Formula
- Read Column
- Read Range
- Read Row
- Select Range
- Set Range Color
- Write Cell
- Write Range
- Save Workbook
- Create Table
- Get Workbook Sheet
- Get Workbook Sheets
- Refresh Pivot Table
- Create Pivot Table
- Get Selected Range
- Copy Sheet
- Delete Range
- Auto Fill Range
- Copy Paste Range
- Execute Macro
- Insert/Delete Columns
- Insert/Delete Rows
- Invoke VBA
- LookUp Range
- Remove Duplicates Range
- Excel Process Scope
- Manage CSV Files
- Filter CSV Files
- Verify CSV Files
- Table Functions
- Manage Multiple Excel Files
- Interpret Excel Results
- Manage Pivot Tables
- Manage Range Selection
- Read From Excel Files
- Manage Databases in Excel
- Compare CSV Files
- Compare Numeric Values
- Sort Data in Excel Files
- Filter and Delete Rows in Excel Files
- Manipulate Range Selections
- Verify Excel Workbook Data
- Read, Write, and Append Data in Excel
- Google Workspace
- Release notes
- About the Google Workspace activities package
- Project compatibility
- Add Attendee
- Create Event
- Delete Event
- Modify Event
- Search Events
- Use Google Drive
- Share File
- Delete File Permission
- Get File Permissions
- Update File Permission
- Copy File
- Create Folder
- Delete File
- Download File
- Find Files and Folders
- Get File Info
- Move File
- Upload File
- Create Document
- Create New Spreadsheet
- Get Mail Messages
- Send Mail Messages
- Change Labels
- Use Google Spreadsheet
- Add Delete Columns
- Add Delete Rows
- Auto Fill Range
- Add New Sheet
- Append Row
- Batch Spreadsheet Updates
- Copy Sheet
- Copy Paste Range
- Delete Range
- Delete Sheet
- Get Cell Color
- Get Sheets
- Read Cell
- Read Column
- Read Range
- Read Row
- Rename Sheet
- Write Cell
- Write Range
- Clear Range
- Download Spreadsheet
- Use Google Document
- Batch Document Updates
- Get Document
- Get Text Index
- Insert Text
- Replace Text
- Read All Text
- Create Script Project
- Get Project Content
- Upload Script File
- Create Deployment
- Run Script
- Mail
- Microsoft 365
- Release notes
- About the Microsoft 365 activity package
- Project compatibility
- Connections
- AddEmailCategories
- ArchiveEmail
- DeleteEmail
- DownloadEmail
- DownloadEmailAttachment
- DownloadEmailAttachments
- ForwardEmail
- GetEmail
- GetEmailAttachmentsInfo
- GetEmails
- GetMailFolders
- GetNewestEmail
- MarkEmailAsRead
- MarkEmailAsUnread
- MoveEmail
- RemoveEmailCategories
- ReplyToEmail
- SendEmail
- TurnOffAutomaticReplies
- TurnOnAutomaticReplies
- Merge multiple sheets into a new summary Excel sheet
- Automatically accept calendar invites from your manager
- Move files to dedicated folders by type
- Verify if new employment documents (I9 and ID) match
- Add new customers to a SharePoint List
- Delete SharePoint List items newer than yesterday
- Notify me on Slack when an important Outlook Email is received
- Include creation date in new OneDrive file names
- Notify me by email when a new file is created
- Microsoft 365 Scope
- Add Sheet
- Append Range
- Clear Range
- Copy Range
- Copy Sheet
- Create Workbook
- Delete Range
- Delete Sheet
- Get Cell Color
- Get Sheets
- Read Cell
- Read Column
- Read Range
- Read Row
- Rename Sheet
- Write Cell
- Write Range
- Set Range Color
- Create Table
- Get Table Range
- Insert Column
- Delete Column
- Insert Rows
- Delete Rows
- VLookup Range
- Use OneDrive & SharePoint
- Copy File/Folder
- Create Folder
- Delete File/Folder
- Download File
- Export File as PDF
- Find Files And Folders
- Get File/Folder
- Move File/Folder
- Upload File
- Share File/Folder
- For Each File/Folder
- Forward Mail
- Get Mail
- Move Mail
- Send Mail
- Reply to Mail
- Delete Mail
- Set Mail Categories
- Add Attachment
- Add Attendee
- Add Location
- Create Event
- Delete Event
- Find Meeting Times
- Get Calendars
- Modify Event
- RSVP
- Search Events
- Create Group
- Delete Group
- Get Group
- List Groups
- Create Bucket
- Delete Bucket
- List Buckets
- List Bucket Tasks
- Create Plan
- Get Plan
- List Plans
- Create Task
- Delete Task
- Get Task
- List Tasks
- Update Task
- For Each List
- Get List Info
- For Each List Item
- Delete List Item
- Add List Items
- Update List Item
- Get List Items
- Presentations
- Release Notes
- About the Presentations activity package
- Project Compatibility
- Add or Update Powerpoint Sensitivity Label
- Add Data Table to Slide
- Add File to Slide
- Add Image or Video to Slide
- Add New Slide
- Add Text to Slide
- Copy Paste Slide
- Delete Slide
- Format Slide Content
- Get Powerpoint Sensitivity Label
- Replace Text in Presentation
- Paste Item Into Slide
- Run Presentation Macro
- Save PowerPoint File As
- Save Presentation as PDF
- Use PowerPoint Presentation
- Word
- Release Notes
- About the Word Activities Package
- Project Compatibility
- Word Application Scope / Use Word File
- Add or Update Word Sensitivity Label
- Add Hyperlink to Document
- Add Picture
- Append Text
- Get Word Sensitivity Label
- Insert DataTable in Document
- Paste Chart/Picture Into Document
- Read Text
- Replace Picture
- Replace Text in Document
- Save Document As
- Save Document as PDF
- Set Bookmark Content
Google Workspace Scope
UiPath.GSuite.Activities.GSuiteApplicationScope
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.
Starting with version 2.5.5, you can use the newer Google Workspace activities inside the Scope activity. To learn how to use the Integration Service activities with Google Workspace Application Scope, see How to use Google Workspace activities without Integration Service.
The OAuthClientID authentication type using the UiPath OAuth Client (the UiPath public app) in Google Workspace Scope is currently unavailable. Automations using the UiPath public app to authenticate may stop working and throw the following error message: "This app is blocked". We are working to fix the issue and restore the app.
Until we restore the public app, you can use OAuthClientID authentication with a custom Google application created by your organization. To switch from the UiPath public Google application to a custom Google application, take the following steps:
- Create your own Google Cloud application, assign the necessary scopes, and
create the OAuth Client ID credentials, as explained in Set up applications in Google Cloud.
- The UiPath public app uses the following scopes:
https://www.googleapis.com/auth/calendar
,https://www.googleapis.com/auth/spreadsheets
,https://www.googleapis.com/auth/documents
,https://www.googleapis.com/auth/drive
,https://mail.google.com
. You can use the same scopes or assign custom ones, depending on your needs.
- The UiPath public app uses the following scopes:
- If you select OAuthClientID
authentication type, set the OAuth Client field to Custom. In the
Client ID and Client Secret fields, add your custom app's
credentials.
- Test your automation, republish the project, and run it.
- Connection method - Select the connection method you want to use.
Options available in the dropdown menu are:
- Properties Panel - Configure the connection details in the Properties panel.
- Asset - Use Orchestrator credential assets. We recommend you use this option.
When you select this option, the authentication fields displayed in the Properties Panel option are hidden, because all the authentication information is stored inside the asset.
The Asset method supports the same authentication types as the Properties Panel method: OAuth Client ID, API Key, or Service Account Key.
- Connection assets -
Browse Orchestrator folders to select an asset. This field supports
IResource
variables. Select the Manage Assets button to open Orchestrator. The list of available assets depends on the Orchestrator your Studio and Robot are connected to.- Use the Plus button menu to select Reload Assets if you've updated your assets in Orchestrator. Note that if you add a new asset in Orchestrator while using Studio Desktop, it will not be available straightaway in the Scope activity.
Common
- TimeoutMS - If set, the activity times out with an exception after the set number of milliseconds.
Options
-
Connection Data Store Location - A dropdown list that specifies where the Token Response gets stored. The available property values are Local disk, Orchestrator, or Never store.
- Local disk - The connection tokens are stored in a local folder on the machine. The same connection can be used in multiple processes on the same machine.
- Orchestrator - The connection tokens are stored in Orchestrator as assets in a specified folder. The same connection can be used in multiple processes on multiple machines as long as it has access to the specified Orchestrator folder.
- Never store - The connection tokens are never stored.
- Connection Orchestrator Folder Path - 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.
Service Account Key
- User Email - If you granted Domain Wide Access to the service account, it needs to impersonate a user from the domain. Use this field to enter the impersonated user's email address.
Runtime
- Runtime connection assets - Browse to select an asset. This field allows you to select a different asset for runtime. Use the Plus button menu to select Relative path and enter the full path of the Orchestrator asset containing connection details.
- Connections - Select an account from the list. You can add, delete, and choose what connections to use.
- Authentication Scopes - See the Using the Authentication Scopes wizard section below.
Using the Authentication Scopes wizard
The Scope activity incorporates a universal permissions selector, offering a clear picture of all the used authentication scopes, which the activities need in order to work correctly.
All children activities included in the Google Workspace Application Scope activity are automatically detected as required scopes.
If no scopes are manually selected from the Scopes wizard, the Auto-detect function is applied by default at runtime, and the need for configuring the wizard is eliminated. All the minimum required scopes are selected at runtime.
You can also add a scope manually after adding a child activity to Google Workspace Application Scope.
Authentication
- Authentication Type - A dropdown list that specifies the type of authentication you want to use to access Google Workspace services. The available property values are: ApiKey, OAuthClientID, and ServiceAccountKey. Depending on the authentication type selection, additional property fields may be required.
The property fields below are required only if your Authentication Type value is OAuthClientID.
- Client ID - The credential
ID for the user account. This property supports
String
variables and string formatted values. - Client Secret - The
credential secret for the user account. This property supports
String
variables and string formatted values. - OAuth Client - Indicates
the application (client) to be used. If UiPath is selected, no Client ID
and Client Secret should be provided. The default value is
UiPath
. -
Secure Client Secret - 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.
-
Connection Data Store Location - A dropdown 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 Authentication Type is OAuthClientID.
-
Connection Orchestrator Folder Path - 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 Authentication Type is OAuthClientID.
Service Account Key
The property fields below are required only if your Authentication Type value is Service Account Key.
- Key Type - A dropdown list
that specifies the service account type according to the key file. The available
property values are
JSON
orP12
. For a P12 service account type, the Password and Service Account Email properties are required. - Service Account Email -
The auto-generated email address for the service account. This property supports
String
variables and string formatted values and is required only if your Key Type value isP12
. - User Email - If Has Domain Wide Access is selected, the service account impersonates a user from the domain; use this field to enter the impersonated user's email address.
- Has Domain Wide Access - If selected, the activity grants domain-wide access to the service account. Boolean value.
- Key Path - 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. - Password - The password
for the service account. This property supports
String
variables and string formatted values and is required only if your Key Type value isP12
. - Key Orchestrator Storage
Bucket - The storage bucket used to retrieve the credentials specified
by Key Path. If a Storage Bucket is selected, the Key Path field must specify
the file path in the selected Storage Bucket. If a Storage Bucket is not set,
the Key Path uses a local storage. If you select the Full Path input
mode, you can enter the storage bucket's path as a string or use a
variable.
Note: With this option, you can use Service Account Key authentication in unattended mode much easier. You no longer need to add the P12 or JSON file in the project folder.
API Key
The property field below is required only if your Authentication Type value is ApiKey.
- Api Key - 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 Authentication Type value.
Common
- 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.