Retrieve Sheets

Operation Name

Retrieve Sheets

Lists the names of worksheets in a spreadsheet available on user's Google Drive.

XML type.

For information about using variables, refer to "variables".

Item name	Required/Optional	Use of Variables	Description	Remarks
Name	Required	Not available	Enter the name on the script canvas.

Item name	Required/Optional	Use of Variables	Description	Remarks
Connect To	Required	Not available	Select Global Resources. [Add]: Adds new global resource. [Edit list]: Global resource settings can be managed from "Edit Resource list".
Folder Path	Optional	Available	Select or enter an absolute path of a folder on Google Drive which starts with slash ("/").	The path becomes relative to the "/" root of the filesystem.
File Name	Required	Available	Enter the name of the spreadsheet.

Item name	Description	Remarks
Refresh folder path list	Gets folder path in the specified destination and set to [Folder path].	If [Destination] is specified/edited, or add/edit of folder is performed on Google Drive, the edition can be reflected using this property action.
Refresh file list	Gets file name in the specified folder path and set to [File name].	If [Folder path] is specified/edited, or add/edit of folder is performed on Google Drive, the edition can be reflected using this property action. If variable is set to [Folder path], this action will be invalid.

Item name	Required/Optional	Use of Variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

None.

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

Element name	Attribute name	Description	Remarks
book	-
sheet	-	Occurs for every worksheet retrieved.

Schema is loaded automatically.

See " Edit Schema "for any details .

Mass data processing is not supported.

PSP is not supported.

Component variable name	Description	Remarks
count	Returns the number of worksheets retrieved.	The value defaults to null.
folderPath	Returns the folder path to the spreadsheet read.	The value defaults to null.
fileName	Returns the name of the spreadsheet read.	The value defaults to null.
message_category	Stores the category to which corresponding message code belongs to, when an error occurs.	The value defaults to null.
message_code	Stores its corresponding message code, when an error occurs.	The value defaults to null.
message_level	Stores the severity of the corresponding message code, when an error occurs.	The value defaults to null.
error_type	Stroes the type of the occured error.	The value defaults to null. Error is represented in the format depicted below. Example:java.io.FileNotFoundException The message may vary depending on DataSpider Servista version.
error_message	Stroes the error message for the occured error occurred.	The value defaults to null. The message may vary depending on DataSpider Servista version.
error_trace	Stores stack trace of the occurred error.	The value defaults to null. The message may vary depending on DataSpider Servista version or the client application used.

About Spreadsheet and folders with the same name
- If two or more files/folders whose path is the same as the path of the spreadsheet specified in [File Name] exist, this operation reads one of them.
- If two or more folders whose path is the same as [Folder Path] exist, this operation reads one of them.
Only the files/folders located under "My Drive" can be accessed.

Exception name	Causes	Solution
ResourceNotFoundException Resource definition could not be found.Name: []	[Connect To] is not specified.	Please specify [Connect To].
ResourceNotFoundException Resource definition could not be found.Name: [<name of Global Resources>]	Resource definition selected in [Connect To] is not found.	Please check the global resource specified in [Connect To].
InvalidPropertyConfigurationException <Property name> is not specified.	[<Property name>] is not specified.	Specify the [<Property name>].
InvalidFolderPathException	The folder path specified in the [Folder Path] is invalid.	Please check [Folder Path].
SpreadsheetNotFoundException The spreadsheet specified could not be found. File name:[:<File name>]File Name:[<File Name>]	The spreadsheet specified in the [File Name] could not be found.	Make sure the [File Name] specified meets the following criteria: The spreadsheet the file path points to exist. The specified file path points to neither 'Spreadsheet' nor 'Form'
java.lang.IllegalArgumentException Invalid extended help URI: Request rate limit exceeded.	Exceeded the limit on the number of Google Sheets API invocation allowed concurrently.	Reduce the number of the concurrent invocation.

New format of "spreadsheet" and "form" have been introduced by service update of Google Drive in January 2015 at present. The existing file on Google Drive will be transfered to the new format within 2015.
- This adapter corresponds to both new and old format of "spreadsheet" and the old format of "form".
- If new format of "form" is used, responses can be operated within this adapter by specifying spreadsheet to response destination.

The following error may occur because of excess of the restriction of the Google Sheets API when this operation runs simultaneously in multi-thread. In this case decrease the number of concurrencies.
- java.lang.IllegalArgumentException: Invalid extended help URI: Request rate limit exceeded.