activities
latest
false
UiPath logo, featuring letters U and I in white
Productivity Activities
Last updated Nov 15, 2024

Write Range

UiPath.GSuite.Activities.WriteRangeConnections

Description

Writes a data table to the indicated range from the selected spreadsheet.

Scopes

This activity requires the following scopes:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/spreadsheets

Project compatibility

Windows | Cross-platform

Configuration

  • Google Sheets connection - The connection for the Google Workspace account to use in the activity.
  • Spreadsheet - Select the Google Sheet file to write in. You can also use a variable and define a spreadsheet template. With a template, the activity can generate the ranges dropdown list. Click the Folder docs image icon to browse Google Drive folders and select a spreadsheet. This option accepts input as IResource. Use the Plus docs image button menu to switch to Use variable or Url or ID (String) input modes.
    • If you select Use variable, you can use the output variable from other activities, such as Create Spreadsheet.
    • Spreadsheet URL - The URL or ID of the spreadsheet of interest. This field is available when Url or ID is selected as the input mode. This property supports String variables and string formatted values. For details, see How to Retrieve Spreadsheet IDs.
    • Spreadsheet sample - Select a file with the same ranges as the variable file. The field is visible after clicking Use spreadsheet template. Browse the Google Drive folders and select a spreadsheet. In Studio Desktop, the option is available from the Plus docs image button menu next to Range. This field accepts IResource input. To learn more, see Working with templates.
    • Select the Reload File Data option if you've modified your folders and need to retrieve the latest data.

  • Range - Indicate in which range to write or append the data. You can add a custom range, such as Sheet1!C5:F10, or a named range name, e.g. Clients. This field is prepopulated with information retrieved from the selected spreadsheet or spreadsheet sample. This property supports String variables and string formatted values.
    • Select the Update Ranges option if you've modified your sheets and need to retrieve the latest data.

  • Include headers - If selected, the data table's headers are inserted into the spreadsheet as well. This property supports Boolean values.
  • How to write - Specifies how to add the data to the specified range. The available options are:
    • Overwrite - Overwrite any previous data that exists.
    • Append - Write the data in the first empty row found.
    • Append Right - Write the data in the first empty column found. See the Appending section below for more information.
    • Insert - Insert a row.
  • What to write - The DataTable data that will be written in the spreadsheet. This property supports DataTable variables. For example, you can use the output variable of a Read range activity.
Appending
 Append (to the bottom)Append Right
Plain range (A1 notation)

Write the range to the first empty row found in the targeted range.

It creates the number of rows necessary and fills in the range with the input range.

If there isn't an empty row in the range, append the range to the bottom by inserting the necessary number of rows and adding the input range.

Write the range to the first empty column found in the targeted range.

It creates the number of columns necessary and fills in the range with the input range.

If there isn't an empty column in the range, append the range to the right by inserting the necessary number of columns and adding the input range.

Named range

Write the range to the first empty row found in the targeted range.

It creates the number of rows necessary and fills in the range with the input range.

If there isn't an empty row in the range, append the range to the bottom by inserting the necessary number of rows and adding the input range.

Write the range to the first empty row found in the targeted range.

It creates the number of rows necessary and fills in the range with the input range.

If there isn't an empty row in the range, append the range to the bottom by inserting the necessary number of rows and adding the input range.

Sheets

Write the range to the first empty row found in the targeted sheet.

It creates the number of rows necessary and fills in the range with the input range.

If there isn't an empty row in the range, append the range to the bottom by inserting the necessary number of rows and adding the input range.

Write the range to the first empty column found in the targeted sheet.

It creates the number of columns necessary and fills in the range with the input range.

If there isn't an empty column in the range, append the range to the right by inserting the necessary number of columns and adding the input range.

Known limitations for requests

Be aware of request/response limits when working with ranges. The limit stands at 4 MB, e.g., on average 10,000 cells with 20 characters each for Read requests, and 4,000 cells with 20 characters each for Write requests.

Example



See also:
  • Description
  • Project compatibility
  • Configuration
  • Example

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.