Spreadsheet

A Non-Visible component that helps you to manipulate data with Google Spreadsheet.

---

Events

---

ErrorOccurred

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
message	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
message	text

Event raised when error occurred.

GotAllSheet

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
sheets	dictionary

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
sheets	dictionary

Event raised when all sheets data got.

GotCell

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
value	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
value	text

Event raised when cell data got.

GotColumn

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
values	list

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
values	list

Event raised when column data got.

GotRow

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
values	list

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
values	list

Event raised when row data got.

GotSheetDimension

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
rows	number
columns	number

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
rows	number
columns	number

Event raised when sheet dimension got.

GotSheetId

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
sheetId	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
sheetId	text

Event raised when sheet id got.

GotSheetName

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
sheetName	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
sheetName	text

Event raised when sheet name got.

SheetInserted

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
sheetId	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
sheetId	text

Event raised when new sheet was inserted to spreadsheet.

SpreadsheetCreated

Normal Event BlockGeneric Event Block

Param Name	I/O Type	Getter Block	Setter Block
spreadsheetId	text

Param Name	I/O Type	Getter Block	Setter Block
component	component
notAlreadyHandled	boolean
spreadsheetId	text

Event raised when new spreadsheet was created inside the Google Drive's folder.

Methods

---

AppendRow

Normal Method BlockGeneric Method Block

Param Name	Input Type
values	list

Param Name	Input Type
forComponent	component
values	list

Output Type: Void

Append the new data row at the end of the sheet.

CreateSpreadsheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
spreadsheetName	text
folderId	text

Param Name	Input Type
forComponent	component
spreadsheetName	text
folderId	text

Output Type: Void

Create a new spreadsheet inside the folder.

DeleteColumn

Normal Method BlockGeneric Method Block

Param Name	Input Type
columnIndex	number

Param Name	Input Type
forComponent	component
columnIndex	number

Output Type: Void

Delete the column from sheet, make sure columnIndex must be an integer.

DeleteRow

Normal Method BlockGeneric Method Block

Param Name	Input Type
rowIndex	number

Param Name	Input Type
forComponent	component
rowIndex	number

Output Type: Void

Delete the column from sheet, make sure columnIndex must be an integer.

DeleteSheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetName	text

Param Name	Input Type
forComponent	component
sheetName	text

Output Type: Void

Delete the sheet from spreadsheet.

DeleteSpreadsheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
spreadsheetId	text

Param Name	Input Type
forComponent	component
spreadsheetId	text

Output Type: Void

Delete spreadsheet from Google Drive.

GetAllSheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
forComponent	component

Output Type: Void

Get the details of all sheets.

GetCell

Normal Method BlockGeneric Method Block

Param Name	Input Type
cellId	text

Param Name	Input Type
forComponent	component
cellId	text

Output Type: Void

Get the cell value of given cellId, make sure that the cellId is in the form of "A1" notation.

GetColumn

Normal Method BlockGeneric Method Block

Param Name	Input Type
columnIndex	number

Param Name	Input Type
forComponent	component
columnIndex	number

Output Type: Void

Get the column data from sheet.

GetRow

Normal Method BlockGeneric Method Block

Param Name	Input Type
rowIndex	number

Param Name	Input Type
forComponent	component
rowIndex	number

Output Type: Void

Get the data of the row at given index, make sure rowIndex must be an integer.

GetSheetDimension

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetName	text

Param Name	Input Type
forComponent	component
sheetName	text

Output Type: Void

Get the dimension of the given sheet.

GetSheetId

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetName	text

Param Name	Input Type
forComponent	component
sheetName	text

Output Type: Void

Get sheet id of given sheet name, make sure there is a sheet inside your spreadsheet with given sheet name.

GetSheetName

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetId	text

Param Name	Input Type
forComponent	component
sheetId	text

Output Type: Void

Get sheet name of given sheet id, make sure there is a sheet inside your spreadsheet with given sheet id.

InsertRow

Normal Method BlockGeneric Method Block

Param Name	Input Type
rowIndex	number
values	list

Param Name	Input Type
forComponent	component
rowIndex	number
values	list

Output Type: Void

Insert the new data row with given values(In form of list) to sheet, make sure columnIndex must be an integer.

InsertSheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetName	text

Param Name	Input Type
forComponent	component
sheetName	text

Output Type: Void

Insert new sheet to spreadsheet.

MoveSpreadsheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
spreadsheetId	text
folderId	text

Param Name	Input Type
forComponent	component
spreadsheetId	text
folderId	text

Output Type: Void

Move spreadsheet to another folder.

RenameSheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
sheetName	text
newSheetName	text

Param Name	Input Type
forComponent	component
sheetName	text
newSheetName	text

Output Type: Void

Rename the existing sheet with new name.

RenameSpreadsheet

Normal Method BlockGeneric Method Block

Param Name	Input Type
spreadsheetId	text
spreadsheetName	text

Param Name	Input Type
forComponent	component
spreadsheetId	text
spreadsheetName	text

Output Type: Void

Rename the existing spreadsheet with new name.

SetCell

Normal Method BlockGeneric Method Block

Param Name	Input Type
cellId	text
value	any

Param Name	Input Type
forComponent	component
cellId	text
value	any

Output Type: Void

Set the cell value of given cellId, make sure that the cellId is in the form of "A1" notation.

Block Properties

---

DeploymentKey

Normal Property BlockGeneric Property Block

I/O Type: text

Deployment Key.

SheetName

Normal Property BlockGeneric Property Block

I/O Type: text

Sheet Name.

SpreadsheetID

Normal Property BlockGeneric Property Block

I/O Type: text

Spreadsheet Id.

Component Block

Spreadsheet

Output Type: component