Connectors of org.wso2.ballerina.connectors.googlespreadsheet package
connector ClientConnector (string accessToken, string refreshToken, string clientId, string clientSecret)
Google Spreadsheet client connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
accessToken | string | The accessToken of the Google Spreadsheet account to access the Google Spreadsheet REST API |
refreshToken | string | The refreshToken of the Google Spreadsheet App to access the Google Spreadsheet REST API |
clientId | string | The clientId of the App to access the Google Spreadsheet REST API |
clientSecret | string | The clientSecret of the App to access the Google Spreadsheet REST API |
action addConditionalFormatRuleBatchRequest()
Establishes a new conditional formatting rule
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action addRowsColumnsData()
Append row/rows/column/columns of data
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
range | string | The A1 notation of the values to retrieve |
insertDataOption | string | How the input data should be inserted |
valueInputOption | string | How the input data should be interpreted |
fields | string | Specifying which fields to include in a partial response |
payload | json | It contains the major dimension that results should use and the data that was to be written(values) |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action addSheetBatchRequest()
Add a sheet or multiple sheets to a spreadsheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action appendDimensionBatchRequest()
Append empty rows or columns at the end of the sheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action autoResizeDimensionsBatchRequest()
Automatically resize a column
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action copyPasteBatchRequest()
Copy cell formatting in one range and paste it into another range on the same sheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action copyTo()
Copies a single sheet from a spreadsheet to another spreadsheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
sheetId | string | The ID of the sheet to copy |
payload | json | It contains the ID of the spreadsheet to copy the sheet to |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action createSpreadsheet()
Create a new spreadsheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
payload | json | The payload containing the information of the post that should be send |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action cutPasteBatchRequest()
Cuts the one range and pastes its data, formats, formulas, and merges to the another range on the same sheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action deleteConditionalFormatRuleBatchRequest()
Delete a conditional formatting rule
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action deleteDimensionBatchRequest()
Removing rows, columns and remove part of a row or column
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action deleteSheetBatchRequest()
Remove a sheet or multiple sheets from a given spreadsheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action editCell()
Edit the content of the cell with new values
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
range | string | The A1 notation of the values to retrieve |
valueInputOption | string | How the input data should be interpreted |
payload | json | It contains data about major dimension that results should use and about the values (the data that was to be written) |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action editMultipleCell()
Edit the content of multiple cell with new values
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data about the new values(data) to apply to the spreadsheet and How the input data should be interpreted(valueInputOption) |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getCellData()
Retrieve any set of cell data from a sheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
range | string | The A1 notation of the values to retrieve |
dateTimeRenderOption | string | How dates, times, and durations should be represented in the output |
valueRenderOption | string | How values should be represented in the output |
fields | string | Specifying which fields to include in a partial response |
majorDimension | string | The major dimension that results should use |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getMultipleCellData()
Retrieve any set of cell data including multiple ranges from a sheet
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
ranges | string | The ranges to retrieve from the spreadsheet |
dateTimeRenderOption | string | How dates, times, and durations should be represented in the output |
valueRenderOption | string | How values should be represented in the output |
fields | string | Specifying which fields to include in a partial response |
majorDimension | string | The major dimension that results should use |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action getSheetMetaData()
Retrieve Sheet properties and other metadata
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
includeGridData | string | True if grid data should be returned. This parameter is ignored if a field mask was set in the request |
fields | string | Specifying which fields to include in a partial response |
ranges | string | The ranges to retrieve from the spreadsheet |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action insertDimensionBatchRequest()
Insert an empty row or column at the end or in the middle
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action mergeCellsBatchRequest()
Merge range of cells into a one cell
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action moveDimensionBatchRequest()
Move a row or column / range of rows or columns
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action repeatCellsBatchRequest()
Repeat formatting of the cell into over a range of cells
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action setDataValidationBatchRequest()
Apply data validation rule to a range
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action sortRangeBatchRequest()
Sort a range with multiple sorting specifications
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action updateBordersBatchRequest()
Edit cell borders
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action updateCellsBatchRequest()
Updates all cells in a range with new data that can be cell value, formatting
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action updateConditionalFormatRuleBatchRequest()
Update a conditional formatting rule or its priority
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action updateDimensionPropertiesBatchRequest()
Adjust column width or row height
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |
action updateSheetPropertiesBatchRequest()
Update all sheet properties
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
spreadsheet | ClientConnector | The Google Spreadsheet Connector instance |
spreadsheetId | string | Unique value of the spreadsheet |
payload | json | It contains data that is a kind of update to apply to a spreadsheet |
fields | string | Specifying which fields to include in a partial response |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | response object |