Google Sheets

Google Sheets is a cloud-based spreadsheet software that allows users to create, edit, and collaborate on spreadsheets in real-time.

Categories: productivity-and-collaboration

Type: googleSheets/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Actions

Clear Sheet

Name: clearSheet

Clear a sheet of all values while preserving formats.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetId	Sheet ID	INTEGER Depends On spreadsheetId	The ID of the sheet.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true

Example JSON Structure

{
  "label" : "Clear Sheet",
  "name" : "clearSheet",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetId" : 1,
    "isTheFirstRowHeader" : false
  },
  "type" : "googleSheets/v1/clearSheet"
}

Output

This action does not produce any output.

Create Column

Name: createColumn

Append a new column to the end of the sheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING Depends On spreadsheetId	The name of the sheet.	true
columnName	Column Name	STRING	Name of the new column.	true

Example JSON Structure

{
  "label" : "Create Column",
  "name" : "createColumn",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "columnName" : ""
  },
  "type" : "googleSheets/v1/createColumn"
}

Output

Type: OBJECT

Properties

Name	Type	Description
spreadsheetId	STRING	ID of the spreadsheet.
sheetName	STRING	Name of the sheet.
headers	ARRAY Items [STRING]	List of headers on the sheet.

Output Example

{
  "spreadsheetId" : "",
  "sheetName" : "",
  "headers" : [ "" ]
}

Create Sheet

Name: createSheet

Create a blank sheet with title. Optionally, provide headers.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING	The name of the new sheet.	true
headers	Headers	ARRAY Items [STRING]	The headers of the new sheet.	false

Example JSON Structure

{
  "label" : "Create Sheet",
  "name" : "createSheet",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "headers" : [ "" ]
  },
  "type" : "googleSheets/v1/createSheet"
}

Output

Type: OBJECT

Properties

Name	Type	Description
spreadsheetId	STRING	ID of the spreadsheet.
sheetName	STRING	Name of the sheet.
headers	ARRAY Items [STRING]	List of headers on the sheet.

Output Example

{
  "spreadsheetId" : "",
  "sheetName" : "",
  "headers" : [ "" ]
}

Delete Column

Name: deleteColumn

Delete column on an existing sheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetId	Sheet ID	INTEGER Depends On spreadsheetId	The ID of the sheet.	true
label	Column Label	STRING	The label of the column to be deleted.	true

Example JSON Structure

{
  "label" : "Delete Column",
  "name" : "deleteColumn",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetId" : 1,
    "label" : ""
  },
  "type" : "googleSheets/v1/deleteColumn"
}

Output

This action does not produce any output.

Create Spreadsheet

Name: createSpreadsheet

Create a new spreadsheet in a specified folder.

Properties

Name	Label	Type	Description	Required
title	Title	STRING	Title of the new spreadsheet to be created.	true
folderId	Folder ID	STRING	ID of the folder where the new spreadsheet will be stored. If no folder is selected, the folder will be created in the root folder.	false

Example JSON Structure

{
  "label" : "Create Spreadsheet",
  "name" : "createSpreadsheet",
  "parameters" : {
    "title" : "",
    "folderId" : ""
  },
  "type" : "googleSheets/v1/createSpreadsheet"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Delete Row

Name: deleteRow

Delete row on an existing sheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetId	Sheet ID	INTEGER Depends On spreadsheetId	The ID of the sheet.	true
rowNumber	Row Number	INTEGER	The row number to delete.	true

Example JSON Structure

{
  "label" : "Delete Row",
  "name" : "deleteRow",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetId" : 1,
    "rowNumber" : 1
  },
  "type" : "googleSheets/v1/deleteRow"
}

Output

This action does not produce any output.

Delete Sheet

Name: deleteSheet

Delete a specified sheet from a spreadsheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetId	Sheet ID	INTEGER Depends On spreadsheetId	The ID of the sheet.	true

Example JSON Structure

{
  "label" : "Delete Sheet",
  "name" : "deleteSheet",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetId" : 1
  },
  "type" : "googleSheets/v1/deleteSheet"
}

Output

This action does not produce any output.

Find Row by Number

Name: findRowByNum

Get a row in a Google Sheet by row number.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING Depends On spreadsheetId	The name of the sheet.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true
rowNumber	Row Number	INTEGER	The row number to get from the sheet.	true

Example JSON Structure

{
  "label" : "Find Row by Number",
  "name" : "findRowByNum",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "isTheFirstRowHeader" : false,
    "rowNumber" : 1
  },
  "type" : "googleSheets/v1/findRowByNum"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Insert Multiple Rows

Name: insertMultipleRows

Append rows to the end of the spreadsheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING Depends On spreadsheetId	The name of the sheet.	true
valueInputOption	Value Input Option	STRING Options RAW, USER_ENTERED	How the input data should be interpreted.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true
rows		DYNAMIC_PROPERTIES Depends On spreadsheetId, sheetName, isTheFirstRowHeader		true

Example JSON Structure

{
  "label" : "Insert Multiple Rows",
  "name" : "insertMultipleRows",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "valueInputOption" : "",
    "isTheFirstRowHeader" : false,
    "rows" : { }
  },
  "type" : "googleSheets/v1/insertMultipleRows"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Insert Row

Name: insertRow

Append a row of values to an existing sheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING Depends On spreadsheetId	The name of the sheet.	true
valueInputOption	Value Input Option	STRING Options RAW, USER_ENTERED	How the input data should be interpreted.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true
row		DYNAMIC_PROPERTIES Depends On spreadsheetId, sheetName, isTheFirstRowHeader		true

Example JSON Structure

{
  "label" : "Insert Row",
  "name" : "insertRow",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "valueInputOption" : "",
    "isTheFirstRowHeader" : false,
    "row" : { }
  },
  "type" : "googleSheets/v1/insertRow"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

List Sheets

Name: listSheets

Get all sheets from the spreadsheet.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true

Example JSON Structure

{
  "label" : "List Sheets",
  "name" : "listSheets",
  "parameters" : {
    "spreadsheetId" : ""
  },
  "type" : "googleSheets/v1/listSheets"
}

Output

Type: ARRAY

Items Type: OBJECT

Properties

Name	Type	Description
spreadsheetId	STRING	ID of the spreadsheet.
sheetName	STRING	Name of the sheet.
headers	ARRAY Items [STRING]	List of headers on the sheet.

Output Example

[ {
  "spreadsheetId" : "",
  "sheetName" : "",
  "headers" : [ "" ]
} ]

Update Row

Name: updateRow

Overwrite values in an existing row.

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet ID	STRING	The ID of the spreadsheet to apply the updates to.	true
sheetName	Sheet Name	STRING Depends On spreadsheetId	The name of the sheet.	true
rowNumber	Row Number	INTEGER	The row number to update.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true
updateWholeRow	Update Whole Row	BOOLEAN Options true, false	Whether to update the whole row or just specific columns.	true
row		DYNAMIC_PROPERTIES Depends On spreadsheetId, sheetName, isTheFirstRowHeader, updateWholeRow		true

Example JSON Structure

{
  "label" : "Update Row",
  "name" : "updateRow",
  "parameters" : {
    "spreadsheetId" : "",
    "sheetName" : "",
    "rowNumber" : 1,
    "isTheFirstRowHeader" : false,
    "updateWholeRow" : false,
    "row" : { }
  },
  "type" : "googleSheets/v1/updateRow"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Triggers

New Row

Name: newRow

Triggers when a new row is added.

Type: DYNAMIC_WEBHOOK

Properties

Name	Label	Type	Description	Required
spreadsheetId	Spreadsheet	STRING	The spreadsheet to apply the updates to.	true
isTheFirstRowHeader	Is the First Row Headers?	BOOLEAN Options true, false	If the first row is header.	true
sheetName	Sheet	STRING Depends On spreadsheetId	The name of the sheet	true

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New Row",
  "name" : "newRow",
  "parameters" : {
    "spreadsheetId" : "",
    "isTheFirstRowHeader" : false,
    "sheetName" : ""
  },
  "type" : "googleSheets/v1/newRow"
}

Additional instructions

anl-c-google-sheet-md

CONNECTION

Setting up OAuth2

Turning on Sheets API