Tools
Microsoft Excel
Read, write, and update data
Integrate Microsoft Excel into the workflow. Can read, write, update, add to table, and create new worksheets.
Read data from a Microsoft Excel spreadsheet
| Parameter | Type | Required | Description |
|---|
spreadsheetId | string | Yes | The ID of the spreadsheet to read from |
range | string | No | The range of cells to read from. Accepts "SheetName!A1:B2" for explicit ranges or just "SheetName" to read the used range of that sheet. If omitted, reads the used range of the first sheet. |
| Parameter | Type | Description |
|---|
data | object | Range data from the spreadsheet |
metadata | object | Spreadsheet metadata |
Write data to a Microsoft Excel spreadsheet
| Parameter | Type | Required | Description |
|---|
spreadsheetId | string | Yes | The ID of the spreadsheet to write to |
range | string | No | The range of cells to write to |
values | array | Yes | The data to write to the spreadsheet |
valueInputOption | string | No | The format of the data to write |
| Parameter | Type | Description |
|---|
updatedRange | string | The range that was updated |
updatedRows | number | Number of rows that were updated |
updatedColumns | number | Number of columns that were updated |
updatedCells | number | Number of cells that were updated |
metadata | object | Spreadsheet metadata |
Add new rows to a Microsoft Excel table
| Parameter | Type | Required | Description |
|---|
spreadsheetId | string | Yes | The ID of the spreadsheet containing the table |
tableName | string | Yes | The name of the table to add rows to |
values | array | Yes | The data to add to the table (array of arrays or array of objects) |
| Parameter | Type | Description |
|---|
index | number | Index of the first row that was added |
values | array | Array of rows that were added to the table |
metadata | object | Spreadsheet metadata |
Create a new worksheet (sheet) in a Microsoft Excel workbook
| Parameter | Type | Required | Description |
|---|
spreadsheetId | string | Yes | The ID of the Excel workbook to add the worksheet to |
worksheetName | string | Yes | The name of the new worksheet. Must be unique within the workbook and cannot exceed 31 characters |
| Parameter | Type | Description |
|---|
worksheet | object | Details of the newly created worksheet |
metadata | object | Spreadsheet metadata |
- Category:
tools
- Type:
microsoft_excel
