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

Write Row

UiPath.Gsuite.Activities.WriteRowConnections

Description

Write a row in a selected Sheets file using an Array Row or a Data Row. You can map individual fields to target columns using the Individual Fields option under Data Row.

Scopes

This activity requires the following scopes:

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

OR

  • 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 - The Google spreadsheet to use. Click the Folderdocs image icon to browse Google Drive folders and select a spreadsheet. This option accepts input as IResource. Use the See more button menu to switch to Use variable or Url or ID input (String) 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 - The range to write in. 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.

    • Select the Update Fields option if you've modified your workbook and need to retrieve the latest data.

  • How to write - Specifies how to add the data to the specified range. The available options are:
    • Overwrite - Overwrites any previous data that exists. Writes the row in the exact place. If a range with multiple cells is selected, writes on the first row.
      • Row Position - The row index position where the activity overwrites the row. The index can be used from iterating on the range rows using Read Range or For Each Row. Starts from 0.
    • Append - Indicates how to add the data to the indicated range. Writes the data in the first empty row found and inserts a new row by shifting cells down.
      Note: Appending data does not currently support named ranges.
    • Insert - Inserts a row and writes in the newly inserted row.
      Note: If Has Headers is set to True, the first row in the range is considered the header and the row position 0 is the next row.
  • What to write - The type of data that will be written in the workbook. The available options are:
    • Data Row - Use a Data Row as input data.
    • Array row - Use an Array Row as input data.
    • Individual Fields - Map data to individual target fields. Using individual fields, you write directly in the specified columns. The columns which are not specified aren't cleared and keep the old data.
  • Data Row to write / Array Row to Write - The data in a DataRow or ArrayRow that will be written in the workbook.
  • Has headers - If selected, the column headers are generated by reading the range header. This property supports Boolean values. Default option is Off. This field is displayed if you select the What to write - Individual Fields option.
  • Manage Target Individual Columns - Select additional fields for the current object. This field is displayed if you select the What to write - Individual Fields option.
Note:

Batching API calls is supported for this activity when used inside: For Each Email, For Each File/Folder, For Each Event.

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.