Ballerina API Documentation

Connectors of org.wso2.ballerina.connectors.googlespreadsheet package

connector ClientConnector (string accessToken, string refreshToken, string clientId, string clientSecret)

Google Spreadsheet client connector

Parameters:

Parameter NameData TypeDescription
accessTokenstringThe accessToken of the Google Spreadsheet account to access the Google Spreadsheet REST API
refreshTokenstringThe refreshToken of the Google Spreadsheet App to access the Google Spreadsheet REST API
clientIdstringThe clientId of the App to access the Google Spreadsheet REST API
clientSecretstringThe clientSecret of the App to access the Google Spreadsheet REST API

Actions:

action addConditionalFormatRuleBatchRequest()

Establishes a new conditional formatting rule

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action addRowsColumnsData()

Append row/rows/column/columns of data

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
rangestringThe A1 notation of the values to retrieve
insertDataOptionstringHow the input data should be inserted
valueInputOptionstringHow the input data should be interpreted
fieldsstringSpecifying which fields to include in a partial response
payloadjsonIt contains the major dimension that results should use and the data that was to be written(values)

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action addSheetBatchRequest()

Add a sheet or multiple sheets to a spreadsheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action appendDimensionBatchRequest()

Append empty rows or columns at the end of the sheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action autoResizeDimensionsBatchRequest()

Automatically resize a column

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action copyPasteBatchRequest()

Copy cell formatting in one range and paste it into another range on the same sheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action copyTo()

Copies a single sheet from a spreadsheet to another spreadsheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
sheetIdstringThe ID of the sheet to copy
payloadjsonIt contains the ID of the spreadsheet to copy the sheet to
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action createSpreadsheet()

Create a new spreadsheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
payloadjsonThe payload containing the information of the post that should be send
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse 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 NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action deleteConditionalFormatRuleBatchRequest()

Delete a conditional formatting rule

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action deleteDimensionBatchRequest()

Removing rows, columns and remove part of a row or column

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action deleteSheetBatchRequest()

Remove a sheet or multiple sheets from a given spreadsheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action editCell()

Edit the content of the cell with new values

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
rangestringThe A1 notation of the values to retrieve
valueInputOptionstringHow the input data should be interpreted
payloadjsonIt contains data about major dimension that results should use and about the values (the data that was to be written)
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action editMultipleCell()

Edit the content of multiple cell with new values

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data about the new values(data) to apply to the spreadsheet and How the input data should be interpreted(valueInputOption)
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action getCellData()

Retrieve any set of cell data from a sheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
rangestringThe A1 notation of the values to retrieve
dateTimeRenderOptionstringHow dates, times, and durations should be represented in the output
valueRenderOptionstringHow values should be represented in the output
fieldsstringSpecifying which fields to include in a partial response
majorDimensionstringThe major dimension that results should use

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action getMultipleCellData()

Retrieve any set of cell data including multiple ranges from a sheet

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
rangesstringThe ranges to retrieve from the spreadsheet
dateTimeRenderOptionstringHow dates, times, and durations should be represented in the output
valueRenderOptionstringHow values should be represented in the output
fieldsstringSpecifying which fields to include in a partial response
majorDimensionstringThe major dimension that results should use

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action getSheetMetaData()

Retrieve Sheet properties and other metadata

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
includeGridDatastringTrue if grid data should be returned. This parameter is ignored if a field mask was set in the request
fieldsstringSpecifying which fields to include in a partial response
rangesstringThe ranges to retrieve from the spreadsheet

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action insertDimensionBatchRequest()

Insert an empty row or column at the end or in the middle

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action mergeCellsBatchRequest()

Merge range of cells into a one cell

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action moveDimensionBatchRequest()

Move a row or column / range of rows or columns

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action repeatCellsBatchRequest()

Repeat formatting of the cell into over a range of cells

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action setDataValidationBatchRequest()

Apply data validation rule to a range

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action sortRangeBatchRequest()

Sort a range with multiple sorting specifications

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action updateBordersBatchRequest()

Edit cell borders

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action updateCellsBatchRequest()

Updates all cells in a range with new data that can be cell value, formatting

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action updateConditionalFormatRuleBatchRequest()

Update a conditional formatting rule or its priority

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action updateDimensionPropertiesBatchRequest()

Adjust column width or row height

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object

action updateSheetPropertiesBatchRequest()

Update all sheet properties

Parameters:

Parameter NameData TypeDescription
spreadsheetClientConnectorThe Google Spreadsheet Connector instance
spreadsheetIdstringUnique value of the spreadsheet
payloadjsonIt contains data that is a kind of update to apply to a spreadsheet
fieldsstringSpecifying which fields to include in a partial response

Return Parameters:

Return VariableData TypeDescription
messageresponse object


Menu

  • Connectors
    • ClientConnector (string accessToken, string refreshToken, string clientId, string clientSecret)
      • addConditionalFormatRuleBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • addRowsColumnsData(ClientConnector spreadsheet, string spreadsheetId, string range, string insertDataOption, string valueInputOption, string fields, json payload)
      • addSheetBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • appendDimensionBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • autoResizeDimensionsBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • copyPasteBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • copyTo(ClientConnector spreadsheet, string spreadsheetId, string sheetId, json payload, string fields)
      • createSpreadsheet(ClientConnector spreadsheet, json payload, string fields)
      • cutPasteBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • deleteConditionalFormatRuleBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • deleteDimensionBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • deleteSheetBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • editCell(ClientConnector spreadsheet, string spreadsheetId, string range, string valueInputOption, json payload, string fields)
      • editMultipleCell(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • getCellData(ClientConnector spreadsheet, string spreadsheetId, string range, string dateTimeRenderOption, string valueRenderOption, string fields, string majorDimension)
      • getMultipleCellData(ClientConnector spreadsheet, string spreadsheetId, string ranges, string dateTimeRenderOption, string valueRenderOption, string fields, string majorDimension)
      • getSheetMetaData(ClientConnector spreadsheet, string spreadsheetId, string includeGridData, string fields, string ranges)
      • insertDimensionBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • mergeCellsBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • moveDimensionBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • repeatCellsBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • setDataValidationBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • sortRangeBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • updateBordersBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • updateCellsBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • updateConditionalFormatRuleBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • updateDimensionPropertiesBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)
      • updateSheetPropertiesBatchRequest(ClientConnector spreadsheet, string spreadsheetId, json payload, string fields)

Copyright 2017 Ballerina API Documentation