Google Sheets

Node: googleSheets · Full type: n8n-nodes-base.googleSheets · Version: 4.7

Ergonomic keyword available: GSHEET — see NFLOW.md for shorter syntax.

Credentials

googleApi (alias: @google) / googleSheetsOAuth2Api (alias: @google)

CREDENTIAL @google = googleApi "My Google Sheets"

Operations

Resource: spreadsheet

create

Parameter	Type	Default	Details
title	string	""
sheetsUi	fixedCollection	{}	groups: sheetValues
options	collection	{}	keys: locale, autoRecalc

deleteSpreadsheet

Parameter	Type	Default	Details
documentId	resourceLocator	{...}	required; modes: list, url, id

Resource: sheet

appendOrUpdate

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
dataMode	options	"defineBelow"	autoMapInputData, defineBelow, nothing
columnToMatchOn	options	""
valueToMatchOn	string	""
fieldsUi	fixedCollection	{}	groups: values
columns	resourceMapper	{...}	required
columns	resourceMapper	{...}	required
options	collection	{}	keys: cellFormat, locationDefine, handlingExtraData, handlingExtraData, useAppend

append

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
dataMode	options	"defineBelow"	autoMapInputData, defineBelow, nothing
fieldsUi	fixedCollection	{}	groups: fieldValues
columns	resourceMapper	{...}	required
options	collection	{}	keys: cellFormat, locationDefine, handlingExtraData, handlingExtraData, useAppend

clear

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
clear	options	"wholeSheet"	wholeSheet, specificRows, specificColumns, specificRange
keepFirstRow	boolean	false
startIndex	number	1
rowsToDelete	number	1
startIndex	string	"A"
columnsToDelete	number	1
range	string	"A:F"	required

create

Parameter	Type	Default	Details
title	string	"n8n-sheet"	required
options	collection	{}	keys: hidden, rightToLeft, sheetId, index, tabColor

remove

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name

delete

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
toDelete	options	"rows"	rows, columns
startIndex	number	2
numberToDelete	number	1
startIndex	string	"A"
numberToDelete	number	1

read

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
filtersUI	fixedCollection	{}	groups: values
combineFilters	options	"OR"	AND, OR
combineFilters	options	"AND"	AND, OR
options	collection	{}	keys: dataLocationOnSheet, outputFormatting, returnFirstMatch, returnAllMatches

update

Parameter	Type	Default	Details
sheetName	resourceLocator	{...}	required; modes: list, url, id, name
dataMode	options	"defineBelow"	autoMapInputData, defineBelow, nothing
columnToMatchOn	options	""
valueToMatchOn	string	""
fieldsUi	fixedCollection	{}	groups: values
columns	resourceMapper	{...}	required
columns	resourceMapper	{...}	required
options	collection	{}	keys: cellFormat, locationDefine, handlingExtraData, handlingExtraData

Common Parameters

Parameter	Type	Default	Details
authentication	options	"oAuth2"	serviceAccount, oAuth2
documentId	resourceLocator	{...}	required; modes: list, url, id

Parameter Details

fieldsUi children:

fieldValues group:

Parameter	Type	Default	Details
fieldId	options	""
fieldValue	string	""

options children:

Parameter	Type	Default	Details
cellFormat	options	"USER_ENTERED"	USER_ENTERED, RAW
locationDefine	fixedCollection	{...}	groups: values
handlingExtraData	options	"insertInNewColumn"	insertInNewColumn, ignoreIt, error
handlingExtraData	options	"insertInNewColumn"	insertInNewColumn, ignoreIt, error
useAppend	boolean	false

filtersUI children:

values group:

Parameter	Type	Default	Details
lookupColumn	options	""
lookupValue	string	""

sheetsUi children:

sheetValues group:

Parameter	Type	Default	Details
title	string	""
hidden	boolean	false

Example

NODE "googleSheets" @google AS "Google Sheets" {
  resource: "spreadsheet",
  operation: "create",
  range: {{ $json.range }},
  title: {{ $json.title }}
}