GoogleSheets Library

Overview

Overview

You can work on the GoogleSheets library as it allows users to perform operations such as ConnectGoogleSheets, CreateSpreadsheet, OpenSpreadSheet, ReadRange, GetRowCount, GetColCount, AddRowCol, DeleteRowCol, WriteRange, etc., in conjunction with the Google sheet server.

The features provided by the GoogleSheets library are as follows:

Common Properties

Common Properties

MORE OPTIONS

MORE OPTIONS properties

Properties

Type

Required

Unit

Auto-setting

Description

On Error

Combination box

N

-

N

Specify an action to carry out when an error occurs at the time of execution.

- If not specified: Output errors and exit the task.

- --Ignore--: Ignore the error.

- --Retry--: Try the activity one more time.

- --Goto--: Try the scenario for the specified time if the activity fails.

- _Event: Select an event created within the project. If a handler is specified: Call the specified handler.

DESCRIPTION

DESCRIPTION properties

Properties

Type

Required

Unit

Auto-setting

Description

DESCRIPTION

Text

N

-

N

Enter the description for the activity card.

The description entered in the DESCRIPTION field is used as the description of the activity.

A representative value will be displayed in the absence of the DESCRIPTION input.

ConnectGoogleSheets

ConnectGoogleSheets

Overview

This activity card starts authentication for the Google Sheets you want to connect.

Application procedures

  1. In the [Output] field, enter the variable to which the connection information will be assigned to Connection.

  2. Select an authentication type in Authentication Type .

  3. In the Client Id field, enter the client ID.

Card properties

Common

Properties

Type

Required

Unit

Auto-settings

Description

N

[Output] Connection

Variable

Y

-

N

Enter the variable to which connection information will be assigned.

N

AuthenticationType

Combination box

Y

-

N

Select the authentication type to be used to access the GoogleSheets service. The following options are displayed:-OAuth2ClientID-ServiceAccountKey

N

Client ID

String

Y if Authentication Type is OAuth2ClientID,

otherwise N

-

N

Enter the Client ID.

N

Client Secret

String

Y if Authentication Type is OAuth2ClientID,

otherwise N

-

N

Enter the Client Secret.

N

KeyPath

String

Y if Authentication Type is ServiceAccountKey,

otherwise N

-

N

Enter the path to your service account key JSON file.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleShetts library.

In the case of OAuth2.0, client credentials are cached and stored; if the credentials succeed, the cached credentials are stored until the token expires. This is the same authentication process as Drive Library.

Google Sheets created through the Service AccountKey are invisible on the screen and classified as files with different permissions than the OAuth2 method. This is the same method as Drive Library.

Example of utilization

Connect to GoogleSheets using ConnectGoogleSheets.

ConnectGooglesheets

Sample file

Used variables

this.connection = variable to which connection information will be assigned
this.clientID = User ID of your GoogleSheets account
this.clientSecret = User Secret of GoogleSheets account
this.keyPath = Service account key JSON for your GoogleSheets account

Used properties

Related/Similar activities

CreateSpreadsheet, OpenSpreadSheet

CreateSpreadsheet

CreateSpreadsheet

Overview

This activity card creates a Spreadsheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in SpreadsheetID.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the Title field, enter a title.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] SpreadsheetID

Variable

Y

-

N

Enter a variable to store the generated Spreadsheet ID.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

Title

String

Y

-

N

Enter Title.

Y

MORE OPTIONS properties

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION properties

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Create a Spreadsheet.

CreateSpreadSheet

Sample file

Used variables

this.sheetId = variable to which the generated sparedsheet ID will be assigned
this.connection = connection information variable

Used properties

Related/Similar activities

OpenSpreadSheet

OpenSpreadSheet

OpenSpreadSheet

Overview

This activity card opens an existing Spreadsheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in SpreadsheetID.

  2. In the [Input] field, enter connection information variables in Connection.

  3. Select the type to open the spreadsheet in OpenType .

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] SpreadsheetID

Variable

Y

-

N

Enter a variable to store the generated Spreadsheet ID.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

OpenType

Combination box

Y

-

N

Specifies the type of spreadsheet to open.- SpreadsheetID-Search in Drive

N

SpreadsheetID

String

Y if OpenType is SpreadsheetID,

otherwise N

-

N

Specifies the input target SpreadsheetID.

N

Path

String (Readonly)

Y if OpenType is Search in Drive,

N otherwise

-

N

The path to the Spreadsheet file.

N

Client ID

String

Y

-

N

*Credentails Google PopupEnter the Client ID.

N

Client Secret

String

Y

-

N

  • Credentials Google PopupEnter the Client Secret.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Open the Spreadsheet.

Openspreadsheet

Sample file

Used variables

this.sheetId = variable to which the opened sparedsheet ID will be assigned
this.connection = connection information variable

Used properties

Related/Similar activities

CreateSpreadsheet

ReadRange

ReadRange

Overview

This activity card reads the designated area of ​​Spreadsheet.

Application procedures

  1. In the [Output] Values field, enter a variable to store the result.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

When A1 is formatted as $1.23, and A2 is read with =A1, an example of Output value according to ReadCellType is as follows.


Formatted_Value: Formatted value ($1.23)

Unformatted_Value: value without formatting (1.23)


  1. Format: Formula (=A1

The result of ReadRange is a two-dimensional array and is accessed in the following way.

values[0][0]

values[0][1]

ReadRange is an operation that reads based on the existing data, so it operates within the Range.

In the case of Write, since it is a writing function that contains the user's intention, Range expansion other than the existing Index is allowed.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Values

Variable

Y

-

N

Enter a variable to store the specified area results in.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

SheetName

String

Y

-

N

Enter the target sheet name.

N

ReadCellType

Combination box

Y

-

N

Specifies how cell values ​​are read.- Formatted_Value-Unformatted_Value _-Formula

N

Range

String

Y

-

N

Enter the target range.

N

Dimension

Combination box

Y

-

N

Specifies the reading direction.-Rows-Columns

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Read the designated area of ​​Spreadsheet.

ReadRange

Sample file

Used variables

RESULT = Enter a variable to save the result of reading the designated area.
this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar activities

WriteRange

GetRowCount

GetRowCount

Overview

This activity card spreadsheets gets the number of rows in the target sheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in RowCount.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] RowCount

Variable

Y

-

N

Enter a variable to store the row count.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

SheetName

String

Y

-

N

Enter the target sheet name.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Spreadsheet Gets the number of rows in the target sheet.

GetRowcount

Sample file

Used variables

RESULT = Enter a variable to save the result of reading the designated area.
this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar Activities

AddRow/Col, DeleteRow/Col

GetColCount

GetColCount

Overview

In this activity card spreadsheet gets the number of columns in the target sheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in ColCount.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] ColCount

Variable

Y

-

N

Enter a variable to store the number of columns.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

SheetName

String

Y

-

N

Enter the target sheet name.

Y

MORE OPTIONS properties

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION properties

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Spreadsheet Gets the number of columns in the target sheet.

getcolCount

Sample file

Used variables

RESULT = Enter a variable to save the result of reading the designated area.
this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar Activities

AddRow/Col , DeleteRow/Col

AddRow/Col

AddRow/Col

Overview

Add rows or columns to the spreadsheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in Row/ColCount.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Row/ColCount

Variable

Y

-

N

Enter a variable to store the row/column count.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

SheetName

String

Y

-

N

Enter the target sheet name.

N

Dimension

Combination

box

Y

-

N

Specifies the direction of row/column addition.-Rows-Columns

N

StartIndex

Number

Y

-

N

Enter the StartIndex of the location to add.

N

EndIndex

Number

Y

-

N

Enter the EndIndex of the location to add.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Add rows or columns to the spreadsheet.

Addrow

Sample file

Used variables

RESULT = Enter a variable to store the number of rows/columns.
this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar Activities

GetRowCount, GetColCount DeleteRow/Col

DeleteRow/Col

DeleteRow/Col

Overview

This activity card deletes a row or column in the spreadsheet.

Application procedures

  1. In the [Output] field, enter a variable to store the result in Row/ColCount.

  2. In the [Input] field, enter connection information variables in Connection.

  3. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Row/ColCount

Variable

Y

-

N

Enter a variable to store the row/column count.

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

SheetName

String

Y

-

N

Enter the target sheet name.

N

Dimension

Combination Box

Y

-

N

Specifies the row/column deletion direction.-Rows-Columns

N

StartIndex

Number

Y

-

N

Enter the StartIndex of the location to be deleted.

N

EndIndex

Number

Y

-

N

Enter the EndIndex of the position to be deleted.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Delete a row or column in the spreadsheet.

DeleteRow

Sample file

Used variables

RESULT = Enter a variable to store the number of rows/columns.
this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar Activities

GetRowCount , GetColCount , AddRow/Col

WriteRange

WriteRange

Overview

This activity card enters the values ​​in the designated area of ​​the spreadsheet.

Application procedures

  1. In the [Input] field, enter connection information variables in Connection.

  2. In the [Input] field, enter the SpreadsheetID to be input in SpreadsheetID.

ReadRange is an operation that reads based on the existing data, so it operates within the Range.

In the case of Write, since it is a writing function that contains the user's intention, Range expansion other than the existing Index is allowed.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

N

Enter the connection information variables.

N

[Input] SpreadsheetID

Variable

Y

-

N

Enter the SpreadsheetID variable to be entered.

N

Values

String

Y

-

N

Enter an array to use as input.

N

SheetName

String

Y

-

N

Enter the target sheet name.

N

Range

String

Y

-

N

Enter the target range.

N

Dimension

combination box

Y

-

N

Specifies the input direction.-Rows-Columns

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Enter values ​​in the designated area of ​​the spreadsheet.

WriteRange

Sample file

Used variables

this.connection = connection information variable
this.sheetId = variable to which the sparedsheet ID will be assigned

Used properties

Related/Similar Activities

ReadRange

AddSheet

AddSheet

Overview

This activity card adds a new spreadsheet.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

N

Sheet

String

Y

-

Y

Enter the name of the target sheet.

N

PositionIndex

Number

N

-

N

Enter the Index of the location you want to add.

N

Columns

Number

N

-

N

Enter the number of Colums to add.

N

Rows

Number

N

-

N

Enter the number of Rows to add.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Add a new sheet to the spreadsheet.

Addsheet

Sample file

Used variables

Global.connection = connection information variable
this.sheetId = variable to which spreadsheet ID will be assigned

Used properties

Related/Similar activities

GetSheets, CopySheet, DeleteSheet, RenameSheet

GetSheets

GetSheets

Overview

This activity card gets a list of sheet names.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Output] Sheets

Variable

Y

-

Y

Enter the variable to store the results.

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Get a list of sheet names.

Getsheets

Sample file

Used variables

Global.connection = connection information variable
this.sheetId = variable to which spreadsheet ID will be assigned

Used properties

Related/Similar activities

AddSheet, CopySheet, DeleteSheet, RenameSheet

CopySheet

CopySheet

Overview

This activity card copies the sheets in the spreadsheet.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

To use the Select type of SheetInputType, enter the actual ID in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

N

SheetInputType

ComboBox

Y

-

Y

Specifies the Sheet input type.- Key In- Select

N

Sheet

String

Y

-

N

Enter the name of the target sheet. If SheetInputType is Select, it is entered in the pop-up. (Readonly)

N

Client ID

String

Y

-

N

Enter the Client ID.

N

Client Secret

String

Y

-

N

Enter the Client Secret.

N

OpenType

ComboBox

Y

-

Y

Specifies the type to open the SpreadSheet.- SpreadsheetID- SearchInDrive

N

PasteSpreadsheetID

String

If OpenType is SpreadsheetID, then Y, or N

-

N

Specifies the SpreadsheetID to paste.

N

Path

String

If OpenType is SearchInDrive, then Y, or N

-

N

The path to the spreadsheet file. (Readonly)

N

NewSheet

String

Y

-

N

Specify the name of the new sheet.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Copy the sheets in the spreadsheet.

CopySheet

Sample file

Used variables

Global.connection = connection information variable
this.sheetId = variable to which spreadsheet ID will be assigned
this.pasteSheetId = The variable to which pasteSparedsheet ID will be assigned.

Used properties

Related/Similar activities

AddSheet, GetSheets, DeleteSheet, RenameSheet

DeleteRange

DeleteRange

Overview

This activity card deletes a specific Range in the spreadsheet.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

To use the Select type of SheetInputType, enter the actual ID in SpreadsheetID.

If you select RangeInputType as Select, you must preset the Namerange in the GoogleSheet UI and proceed with Select.

Menu > Data > Named ranges for each spreadsheet.

Card properties

Commona

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

N

SheetInputType

ComboBox

Y

-

Y

Specifies the Sheet input type.- Key In- Select

N

Sheet

String

Y

-

N

Enter the name of the target sheet. If SheetInputType is Select, it is entered in the pop-up. (Readonly)

N

Client ID

String

Y

-

N

Enter the Client ID.

N

Client Secret

String

Y

-

N

Enter the Client Secret.

N

RangeInputType

ComboBox

Y

-

Y

Select the input type.

- Key In

- Select

N

Range

String

Y

-

Y

Enter the destination Range. If RangeInputType is Select, it is entered in a pop-up. (Readonly)

N

Shift

ComboBox

Y

-

Y

Specify the shift direction.

- No Shift

- Left- Up

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Deletes a specific Range in the spreadsheet.

DeleteRange

Sample file

Used variables

Global.connection = Connection Information Variable
this.sheetId = variable to which sparedsheet ID will be assigned

Used properties

Related/Similar activities

ReadRange

DeleteSheet

DeleteSheet

Overview

This activity card deletes the sheet in the spreadsheet.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

To use the Select type of SheetInputType, enter the actual ID in SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

N

SheetInputType

ComboBox

Y

-

Y

Select the Sheet input type

- Key In

- Select

N

Sheet

String

Y

-

N

Enter the name of the target sheet. If SheetInputType is Select, it is entered in the pop-up. (Readonly)

N

Client ID

String

Y

-

N

Enter the Client ID.

N

Client Secret

String

Y

-

N

Enter the Client Secret.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Delete the sheet in the spreadsheet.

DeleteSheet

Sample file

Used variables

Global.connection = connection information variable
this.sheetId = variable to which spreadsheet ID will be assigned

Used properties

Related/Similar activities

AddSheet, GetSheets CopySheet, RenameSheet

RenameSheet

RenameSheet

Overview

This activity card modifies the sheet name of the spreadsheet.

Application procedures

  1. In the [Input] Connection field, enter connection information variables in Connection.

  2. In the [Input] SpreadsheetID field, enter the SpreadsheetID.

Card properties

Common

Properties

Type

Required

Unit

Auto-setting

Description

N

[Input] Connection

Variable

Y

-

Y

Enter the connection information variable.

N

[Input] SpreadsheetID

Variable

Y

-

Y

Enter the input destination SpreadsheetID variable.

N

SheetInputType

ComboBox

Y

-

Y

Select the Sheet input type.

- Key In

- Select

N

Sheet

String

Y

-

N

Enter the name of the target sheet.

If SheetInputType is Select, it is entered in the pop-up. (Readonly)

N

Client ID

String

Y

-

N

Enter the Client ID.

N

Client Secret

String

Y

-

N

Enter the Client Secret.

N

NewSheet

String

Y

-

N

Enter the name of the new sheet.

Y

MORE OPTIONS

-

-

-

-

Common properties of the GoogleSheets library.

Y

DESCRIPTION

-

-

-

-

Common properties of the GoogleSheets library.

Example of utilization

Modify the sheet name of the spreadsheet.

Renamesheet

Sample file

Used variables

Global.connection = connection information variable
this.sheetId = variable to which spreadsheet ID will be assigned

Used properties

Related/Similar activities

AddSheet, GetSheets, CopySheet, DeleteSheet