Official |[Google Sheets] Retrieve Sheets

Operation name

Retrieve Sheets

Function overview

Lists the names of worksheets in a spreadsheet on Google Drive.

Data model

The data model of this component is XML type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Connect To	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Folder Path	Optional	Available	Select or enter an absolute path of a folder on Google Drive which starts with slash "/".	If omitted, the root folder "/" is used.
File Name	Required	Available	Enter the file name of the spreadsheet.

Item name

Required/Optional

Use of variables

Description

Remarks

Connect To

Required

Not available

Select a connection resource.

Add: A new connection resource can be added.
Edit list: Connection resource settings can be edited in > HULFT INTEGRATE > Connections.

Folder Path

Optional

Available

Select or enter an absolute path of a folder on Google Drive which starts with slash "/".

If omitted, the root folder "/" is used.

File Name

Required

Available

Enter the file name of the spreadsheet.

Property actions

Item name	Description	Remarks
Refresh folder path list	Get folder paths in the specified destination and set them to Folder path.	If Destination is specified/edited or a folder has been added/edited on Google Drive, the changes can be reflected using this property action.
Refresh file list	Get file names in the specified folder path and set them to File name.	If Folder path is specified/edited or a file has been added/edited on Google Drive, the changes can be reflected using this property action. If a variable is set to Folder path, this action will be invalid.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

<?xml version="1.0" encoding="UTF-8"?>
<book>
 <sheet><![CDATA[Sheet name]]></sheet>
</book>

Element name	Attribute name	Description	Remarks
book	-
sheet	-	Appears once for each worksheet retrieved.

Element name

Attribute name

Description

Remarks

book

-

sheet

-

Appears once for each worksheet retrieved.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
count	The number of worksheets retrieved is returned.	The default value is null.
folderPath	The folder path to the spreadsheet read is returned.	The default value is null.
fileName	The name of the spreadsheet read is returned.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the Google Sheets connector