Google Spreadsheet Connector

The Google Spreadsheet Connector allows you to access the Google Sheets API from an integration sequence. This connector provides operations for working with spreadsheets, sheets, cells, and formatting.

Connection Configuration

To use the Google Spreadsheet Connector, you need to configure a connection. The connection configuration requires the following parameters:

• Client ID: The client ID of your Google Cloud project.
• Client Secret: The client secret of your Google Cloud project.
• Refresh Token: The refresh token for your Google account.

You can obtain these credentials by following the steps in the Configure Google Sheets API.

Sheet-level Operations

googlespreadsheet.createSpreadsheet

Creates a new spreadsheet in Google Sheets with specified properties. The operation supports Basic and Advanced configuration modes.

Configuration Levels:

• BASIC: Create a simple spreadsheet with minimal configuration
  
• ADVANCED: Full control over spreadsheet creation with multiple sheets and properties

Basic Mode

Parameter Name	Description	Required
title	Name of the spreadsheet	Yes
initialSheetName	Name for the first sheet	No (defaults to "Sheet1")

Advanced Mode

Parameter Name	Description	Required
properties	Spreadsheet properties (title, locale, etc.)	No
sheets	Array of sheet configurations	No
namedRanges	Named cell ranges definitions	No

Sample configuration

<googlespreadsheet.createSpreadsheet configKey="SpreadsheetConnection">
    <configLevel>BASIC</configLevel>
    <title>{${payload.title}}</title>
    <initialSheetName>First Sheet</initialSheetName>
</googlespreadsheet.createSpreadsheet>

Sample request

{
    "title": "Annual Budget 2025"
}

Sample response

{
    "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
    "properties": {
        "title": "Annual Budget 2025"
    },
    "sheets": [
        {
            "properties": {
                "sheetId": 0,
                "title": "First Sheet",
                "index": 0,
                "sheetType": "GRID",
                "gridProperties": {
                    "rowCount": 1000,
                    "columnCount": 26
                }
            }
        }
    ],
    "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/edit"
}

googlespreadsheet.addSheet

The addSheet operation allows you to add new sheets to an existing spreadsheet. You can specify the sheet properties for the new sheet. An error is thrown if you provide a title that is used for an existing sheet. For more information, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is an update to apply to a spreadsheet. To add multiple sheets within the spread sheet, need to repeat "addSheet" property within the requests attribute as below.	Yes.
fields	Specifying which fields to include in a partial response. For the following request only the "spreadsheetId" will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.addSheet configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.addSheet>

Sample request

The sample request given below calls the addSheet operation. The request specifies the multiple sheet properties, such as the sheet name ("Expenses1", "Expenses2"), sheet type ("GRID"), and the dimension ((50,10), (70,10)) of the sheet as an array. The fields property is specified to get a partial response. The spreadsheetId and replies values will be included in the response. replies contain properties such as sheet name, type, row, column count, and sheetId.

{
    "clientId":"617729022812-xxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A",
    "requests": [
    {
        "addSheet": {
            "properties": {
                "title": "Expenses1",
                "sheetType": "GRID",
                "gridProperties": {
                    "rowCount": 50,
                    "columnCount": 10
                }
            }
        }
    },
    {
        "addSheet": {
            "properties": {
                "title": "Expenses2",
                "sheetType": "GRID",
                "gridProperties": {
                    "rowCount": 70,
                    "columnCount": 10
                }
            }
        }
    }
    ],
    "fields": "spreadsheetId,replies"
}

Sample response

{
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A",
    "replies": [
        {
            "addSheet": {
                "properties": {
                    "sheetId": 372552230,
                    "title": "Expenses1",
                    "index": 1,
                    "sheetType": "GRID",
                    "gridProperties": {
                        "rowCount": 50,
                        "columnCount": 10
                    }
                }
            }
        },
        {
            "addSheet": {
                "properties": {
                    "sheetId": 568417391,
                    "title": "Expenses2",
                    "index": 2,
                    "sheetType": "GRID",
                    "gridProperties": {
                        "rowCount": 70,
                        "columnCount": 10
                    }
                }
            }
        }
    ]
}

googlespreadsheet.deleteSheet

The deleteSheet operation allows you to remove sheets from a given spreadsheet using "sheetId". You can get the "sheetId" using the getSheetMetaData operation. For more information, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is an update to apply to a spreadsheet. To add multiple sheets within the spread sheet, need to repeat "addSheet" property within the requests attribute as below.	Yes.
fields	Specifying which fields to include in a partial response. For the following request only the "spreadsheetId" will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.deleteSheet configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.deleteSheet>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmxxxxxxxxxxxxxxxxxxxxxKMEIFGCD9EBdrXFGA",
    "requests": [
    {
        "deleteSheet":
        {
            "sheetId": 813171540
        }
    }
    ],
    "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.getSheetMetaData

The getSheetMetaData operation allows you to provides the sheet metadata within a given spreadsheet. This method can be used to acquire sheet properties and other metadata. If you only want to read the sheet properties, set the includeGridData query parameter to false to prevent the inclusion of the spreadsheet cell data. The Spreadsheet response contains an array of Sheet objects. The sheet titles and size information specifically can be found under the SheetProperties element of these objects. For more information, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
includeGridData	True if grid data should be returned. This parameter is ignored if a field mask was set in the request.	Optional.
fields	Specifying which fields to include in a partial response.	Optional.
ranges	The ranges to retrieve from the spreadsheet.	Optional.

Sample configurations

<googlespreadsheet.getSheetMetaData configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <includeGridData>{${payload.includeGridData}}</includeGridData>
    <ranges>{${payload.ranges}}</ranges>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.getSheetMetaData>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A",
    "includeGridData":"false",
    "ranges": "Employees!A1:B2"
}

Sample response

{
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A",
    "properties": {
        "title": "Company",
        "locale": "en_US",
        "autoRecalc": "ON_CHANGE",
        "timeZone": "Etc/GMT",
        "defaultFormat": {
            "backgroundColor": {
                "red": 1,
                "green": 1,
                "blue": 1
            },
            "padding": {
                "top": 2,
                "right": 3,
                "bottom": 2,
                "left": 3
            },
            "verticalAlignment": "BOTTOM",
            "wrapStrategy": "OVERFLOW_CELL",
            "textFormat": {
                "foregroundColor": {},
                "fontFamily": "arial,sans,sans-serif",
                "fontSize": 10,
                "bold": false,
                "italic": false,
                "strikethrough": false,
                "underline": false
            }
        }
    },
    "sheets": [
        {
            "properties": {
                "sheetId": 789,
                "title": "Employees",
                "index": 0,
                "sheetType": "GRID",
                "gridProperties": {
                    "rowCount": 1000,
                    "columnCount": 26
                }
            }
        }
    ],
    "spreadsheetUrl": "https://docs.google.com/spreadsheets/d/1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A/edit"
}

googlespreadsheet.updateSheetProperties

The updateSheetProperties operation allows you to update all sheet properties. This method allows you to update the size, title, and other sheet properties, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To Update multiple sheets properties within the spread sheet, need to repeat updateSheetProperties property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response. This is define outside the requests body.	Optional.

Sample configurations

<googlespreadsheet.updateSheetProperties configKey="SpreadsheetConnection">
      <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
      <requests>{${payload.requests}}</requests>
      <fields>{${payload.fields}}</fields>
</googlespreadsheet.updateSheetProperties>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A",
    "requests": [
      {
       "updateSheetProperties": {
        "properties": {
         "sheetId": 789,
         "gridProperties": {
          "columnCount": 25,
          "rowCount": 10
         },
         "title": "Sheet1"
        },
        "fields": "title,gridProperties(rowCount,columnCount)"
       }
      }
     ],
     "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "1oGxpE3C_2elS4kcCZaB3JqVMiXCYLamC1CXZOgBzy9A"
}

googlespreadsheet.copySheet

The copySheet operation allows you to copy a single sheet from a spreadsheet to another spreadsheet. Returns the properties of the newly created sheet, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
sheetId	The ID of the sheet to copy.	Yes.
destinationSpreadsheetId	The ID of the spreadsheet to copy the sheet to.	Optional.
fields	Specifying which fields to include in a partial response.	Optional.

Sample configurations

<googlespreadsheet.copySheet configKey="SpreadsheetConnection">
     <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
     <sheetId>{${payload.sheetId}}</sheetId>
     <destinationSpreadsheetId>{${payload.destinationSpreadsheetId}}</destinationSpreadsheetId>
     <fields>{${payload.fields}}</fields>
</googlespreadsheet.copySheet>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxx-fCyxRTyf-xxxxxxxxxxx",
    "accessToken":"ya29.xxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "1oGxpE3C_2elS4kcCxxxxxxxxxxxxLamC1CXZOgBzy9A",
    "sheetId":"789",
    "destinationSpreadsheetId":"12KoqoxmykLLYbxxxxxxxxxxxxxxxxxxxxEIFGCD9EBdrXFGA"
}

Sample response

{
    "sheetId": 813171540,
    "title": "Copy of Sheet1",
    "index": 1,
    "sheetType": "GRID",
    "gridProperties": {
        "rowCount": 10,
        "columnCount": 25
    }
}

---

Cell-level Operations

googlespreadsheet.getCellData

Retrieves cell contents and formatting. Supports both Basic and Advanced modes for different levels of control.

Configuration Levels:

• BASIC: Simple cell data retrieval using sheet name and cell reference
  
• ADVANCED: Complex data retrieval with formatting options

Basic Mode

Parameter Name	Description	Required
spreadsheetId	Unique identifier of the spreadsheet	Yes
sheetName	Name of the sheet	Yes
cellId	Cell reference (e.g., "A1")	Yes

Advanced Mode

Parameter Name	Description	Required
spreadsheetId	Unique identifier of the spreadsheet	Yes
range	A1 notation range	Yes
valueRenderOption	How to render cell values (FORMATTED_VALUE, UNFORMATTED_VALUE, FORMULA)	No
dateTimeRenderOption	How to render dates/times	No

Sample configuration

<googlespreadsheet.getCellData configKey="SpreadsheetConnection">
    <configLevel>BASIC</configLevel>
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <sheetName>Sheet1</sheetName>
    <cellId>A1</cellId>
</googlespreadsheet.getCellData>

Sample response

{
    "range": "Sheet1!A1",
    "majorDimension": "ROWS",
    "values": [
        ["Cell Content"]
    ]
}

googlespreadsheet.editCellData

Edits cell contents with new values. Supports both Basic and Advanced configuration modes.

Configuration Levels:

• BASIC: Simple cell value updates
  
• ADVANCED: Complex updates with formatting and multiple cells

Basic Mode

Parameter Name	Description	Required
spreadsheetId	Unique identifier of the spreadsheet	Yes
sheetName	Name of the sheet	Yes
cellId	Cell reference (e.g., "A1")	Yes
value	New value for the cell	Yes

Advanced Mode

Parameter Name	Description	Required
spreadsheetId	Unique identifier of the spreadsheet	Yes
range	A1 notation range	Yes
values	Array of values to update	Yes
valueInputOption	How to interpret input (RAW or USER_ENTERED)	No (defaults to USER_ENTERED)

Sample configuration

<googlespreadsheet.editCellData configKey="SpreadsheetConnection">
    <configLevel>BASIC</configLevel>
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <sheetName>Sheet1</sheetName>
    <cellId>A1</cellId>
    <value>New Value</value>
</googlespreadsheet.editCellData>

Sample request

{
    "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
    "value": "Updated Content"
}

Sample response

{
    "spreadsheetId": "1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms",
    "updatedRange": "Sheet1!A1",
    "updatedRows": 1,
    "updatedColumns": 1,
    "updatedCells": 1
}

googlespreadsheet.getMultipleCellData

The getMultipleCellData method allow you to retrieve any set of cell data from a sheet (including multiple ranges). It return cell contents not only as input values (as would be entered by a user at a keyboard) but also it grants full access to values, formulas, formatting, hyperlinks, data validation, and other properties. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
ranges	The ranges of the values to retrieve from the spreadsheet.	Optional.
dateTimeRenderOption	How dates, times, and durations should be represented in the output. For more detail click here.	Optional.
majorDimension	The major dimension that results should use. For more detail click here.	Optional.
valueRenderOption	How values should be represented in the output. For more detail click here.	Optional.
fields	Specifying which fields to include in a partial response. For the following request only the valueRanges will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.getMultipleCellData configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <ranges>{${payload.ranges}}</ranges>
    <dateTimeRenderOption>{${payload.dateTimeRenderOption}}</dateTimeRenderOption>
    <majorDimension>{${payload.majorDimension}}</majorDimension>
    <valueRenderOption>{${payload.valueRenderOption}}</valueRenderOption>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.getMultipleCellData>

Sample request

This will allow you to get cell data by specifying multiple cell range using ranges parameter. Here we can specify multiple cell ranges as a comma sperated.

{
    "clientId":"617729022812-xxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "ranges":"Sheet1!A1:B2,Sheet1!B1:C2,Sheet1!D4:G5",
    "dateTimeRenderOption":"SERIAL_NUMBER",
    "majorDimension":"ROWS",
    "valueRenderOption":"UNFORMATTED_VALUE"
}

Sample response

In the response we will get all cell data that is in the specified cell ranges.

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "valueRanges": [
        {
            "range": "Sheet1!A1:B2",
            "majorDimension": "ROWS",
            "values": [
                [
                    "20",
                    "21"
                ],
                [
                    "22",
                    "23"
                ]
            ]
        },
        {
            "range": "Sheet1!B1:C2",
            "majorDimension": "ROWS",
            "values": [
                [
                    "21",
                    34
                ],
                [
                    "23",
                    47
                ]
            ]
        },
        {
            "range": "Sheet1!D4:G5",
            "majorDimension": "ROWS"
        }
    ]
}

googlespreadsheet.updateMultipleCell

The updateMultipleCell method allow you to edit the content of multiple cell with new values. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
data	The new values to apply to the spreadsheet.	Optional.
valueInputOption	How the input data should be interpreted. For more detail click here.	Optional.
fields	Specifying which fields to include in a partial response.	Optional.

Sample configurations

<googlespreadsheet.updateMultipleCell configKey="SpreadsheetConnection">
     <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
     <data>{${payload.data}}</data>
     <valueInputOption>{${payload.valueInputOption}}</valueInputOption>
     <fields>{${payload.fields}}</fields>
</googlespreadsheet.updateMultipleCell>

Sample request

Edit the content of multiple cell ranges with new values. We can specify multiple cell ranges and values as JSON array in data.

{
    "clientId":"617729022812-xxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxx",
    "refreshToken":"1/Si2q4aOZsaMlYW7bBIoO-xxxxxxxxxxxxx-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "valueInputOption":"RAW",
    "data": [
          {
            "values": [["7","8"],["9","10"]],
            "range": "Sheet1!A6"
       }
    ]
}

Sample response

In the response we will get updated cell, range details as as array in responses property.

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "totalUpdatedRows": 2,
    "totalUpdatedColumns": 2,
    "totalUpdatedCells": 4,
    "totalUpdatedSheets": 1,
    "responses": [
        {
            "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
            "updatedRange": "Sheet1!A6:B7",
            "updatedRows": 2,
            "updatedColumns": 2,
            "updatedCells": 4
        }
    ]
}

Row and Column Operations

googlespreadsheet.updateDimensionProperties

The updateDimensionProperties method allows you to updates properties of dimensions within the specified range,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple updateDimensionProperties operation within the spreadsheet, need to repeat updateDimensionProperties property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.updateDimensionProperties configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.updateDimensionProperties>

Sample request

The following request updates the width of column A to 160 pixels.

{
    "clientId":"617729022812-vjo2edd0i4bcb38ifu4qg17ke5nn6f2m.apps.googleusercontent.com",
    "clientSecret":"ry_AXMsEe5Sn9iVoOY7ATnb8",
    "refreshToken":"1/Si2q4aOZsaMlYW7bBIoO-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-CA9sR2IXoOaVg9fpRwf8fEhF8lqfOJL1FpRihUlNxEa8kw-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "updateDimensionProperties": {
        "range": {
          "sheetId": 1020069232,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 1
        },
        "properties": {
          "pixelSize": 160
        },
        "fields": "pixelSize"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.autoResizeDimensions

The autoResizeDimensions method allows you to automatically resize one or more dimensions based on the contents of the cells in that dimension,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple autoResizeDimensions operation within the spread sheet, need to repeat autoResizeDimensions property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.autoResizeDimensions configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.autoResizeDimensions>

Sample request

The following request turns on automatic resizing of columns A:C, based on the size of the column content. Automatic resizing of rows is not supported.

{
    "clientId":"617729022812-xxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxx-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "autoResizeDimensions": {
        "dimensions": {
          "sheetId": 1020069232,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 3
        }
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.insertDimension

The insertDimension method allows you to inserts rows or columns in a sheet at a particular index.,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple insertDimension operation within the spread sheet, need to repeat insertDimension property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.insertDimension configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.insertDimension>

Sample request

The following request inserts two blank columns at column C. The inheritBefore field, if true, tells the API to give the new columns or rows the same properties as the prior row or column; otherwise the new columns or rows acquire the properties of those that follow them. inheritBefore cannot be true if inserting a row at row 1 or a column at column A.

{
    "clientId":"617729022812-xxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxx",
    "refreshToken":"1/Si2q4aOZsaMlYW7bBIxxxxxxxxxxxxxxoO-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxxxxxxxxx-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests":[
    {
      "insertDimension":
      {
        "range":
        {
          "sheetId": 1020069232,
          "dimension": "COLUMNS",
          "startIndex": 2,
          "endIndex": 4
        },
        "inheritFromBefore": true
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.moveDimension

The moveDimension method allows you to moves one or more rows or columns,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple moveDimension operation within the spread sheet, need to repeat moveDimension property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response. For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.insertDimension configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.insertDimension>

Sample request

The following request moves column A to the column D position.

{
    "clientId":"617729022812-xxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxxx-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests":[
    {
      "moveDimension":
      {
        "source":
        {
          "sheetId": 1020069232,
          "dimension": "COLUMNS",
          "startIndex": 0,
          "endIndex": 1
        },
        "destinationIndex": 3
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.deleteDimension

The deleteDimension method allows you to delete rows or columns by specifying the dimension, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple delete operation within the spreadsheet, need to repeat deleteDimension property within the requests property.	Yes.
fields	Specifying which fields to include in a partial response. For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.deleteDimension configKey="SpreadsheetConnection">
     <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
     <requests>{${payload.requests}}</requests>
     <fields>{${payload.fields}}</fields>
</googlespreadsheet.deleteDimension>

Sample request

The following request deletes the first three rows in the sheet since we specify dimension as ROWS.

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"ry_AXMsEe5Sn9iVoOY7ATnb8",
    "refreshToken":"1/xxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
      {
       "deleteDimension": {
        "range": {
         "sheetId": 121832844,
         "dimension": "ROWS",
         "startIndex": 0,
         "endIndex": 3
        }
       }
      }
     ],
      "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.appendDimension

The appendDimension method allows you to appends empty rows and columns to the end of the sheet. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple updateCells operation within the spread sheet, need to repeat updateCells property within the requests property.	Optional.
fields (Outside the requests property)	Specifying which fields to include in a partial response. For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.appendDimension configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.appendDimension>

Sample request

This sample requst allow you to append diamention in row wise with the length 2.

{
    "clientId":"617729022812-xxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
         {
             "appendDimension": {
             "dimension": "ROWS",
             "sheetId": 121832844,
             "length": 2
         }
         }
         ],
    "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

Cell Formatting Operations

googlespreadsheet.updateBorders

The updateBorders method allow you to edit cell borders. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple updateCells operation within the spread sheet, need to repeat updateCells property within the requests property.	Optional.
fields (Outside the requests property)	Specifying which fields to include in a partial response. For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.updateBorders configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.updateBorders>

Sample request

In following request we can specify for which range of the sheet the border need to be updated and the formatting details of the border.

{
    "clientId":"617729022812-xxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
        {
          "updateBorders":
          {
            "range": {
              "sheetId": 121832844,
              "startRowIndex": 0,
              "endRowIndex": 10,
              "startColumnIndex": 0,
              "endColumnIndex": 6
            },
            "top": {
              "style": "DASHED",
              "width": 1,
              "color": {"blue": 1}
            },
            "bottom":
            {
              "style": "DASHED",
              "width": 1,
              "color": {"blue": 1}
            },
            "innerHorizontal": {
              "style": "DASHED",
              "width": 1,
              "color": {"blue": 1}
            }
           }
       }
    ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.repeatCells

The repeatCells method allow you to updates all cells in the range to the values in the given Cell object. Only the fields listed in the fields(within the requests property)will be updated. Others are unchanged. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple repeatCell operation within the spread sheet, need to repeat repeatCell property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response. For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.repeatCells configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.repeatCells>

Sample request

Here the formating specified in "cell" object will be repeted for row index from 13 to 15.

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
    {
      "repeatCell": {
        "range": {
          "sheetId": 121832844,
          "startRowIndex": 13,
          "endRowIndex": 15
        },
        "cell": {
          "userEnteredFormat": {
            "backgroundColor": {
              "red": 0.0,
              "green": 0.0,
              "blue": 0.0
            }
          }
        },
        "fields": "userEnteredFormat(backgroundColor)"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.mergeCells

The mergeCells method allow you to merges all cells in the range. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple mergeCells operation within the spread sheet, need to repeat mergeCells property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.mergeCells configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.mergeCells>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
    {
      "mergeCells": {
        "range": {
          "sheetId": 121832844,
          "startRowIndex": 0,
          "endRowIndex": 2,
          "startColumnIndex": 0,
          "endColumnIndex": 2
        },
        "mergeType": "MERGE_ALL"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.setDataValidation

The setDataValidation Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified..see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple setDataValidation operation within the spread sheet, need to repeat setDataValidation property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.setDataValidation configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.setDataValidation>

Sample request

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
    {
      "mergeCells": {
        "range": {
          "sheetId": 121832844,
          "startRowIndex": 0,
          "endRowIndex": 2,
          "startColumnIndex": 0,
          "endColumnIndex": 2
        },
        "mergeType": "MERGE_ALL"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.updateConditionalFormatRule

The updateConditionalFormatRule method allows you to updates a conditional format rule at the given index, or moves a conditional format rule to another index,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple updateConditionalFormatRule operation within the spread sheet, need to repeat updateConditionalFormatRule property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.updateConditionalFormatRule configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.updateConditionalFormatRule>

Sample request

The following request replaces the conditional formatting rule at index 0 with a new rule that formats cells containing the exact text specified ("Total Cost") in the A1:D5 range.

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxxxxxxxxxxxxx-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "updateConditionalFormatRule": {
        "sheetId": 1020069232,
        "index": 0,
        "rule": {
          "ranges": [
            {
              "sheetId": 1020069232,
              "startRowIndex": 0,
              "endRowIndex": 5,
              "startColumnIndex": 0,
              "endColumnIndex": 4
            }
          ],
          "booleanRule": {
            "condition": {
              "type": "TEXT_EQ",
              "values": [
                {
                  "userEnteredValue": "Total Cost"
                }
              ]
            },
            "format": {
              "textFormat": {
                "bold": true
              }
            }
          }
        }
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.addConditionalFormatRule

The addConditionalFormatRule method allows you to adds a new conditional format rule at the given index,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple addConditionalFormatRule operation within the spread sheet, need to repeat addConditionalFormatRule property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.addConditionalFormatRule configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.addConditionalFormatRule>

Sample request

The following request establishes new gradient conditional formatting rules for row 10 and 11 of a sheet. The first rule states that cells in that row have their backgrounds colored according to their value. The lowest value in the row will be colored dark red, while the highest value will be colored bright green. The color of other values will be determined by interpolation.

{
    "clientId":"617729022812-vjo2edd0i4bcb38ifu4qg17ke5nn6f2m.apps.googleusercontent.com",
    "clientSecret":"ry_AXMsEe5Sn9iVoOY7ATnb8",
    "refreshToken":"1/Si2q4aOZsaMlYW7bBIoO-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-CA9sR2IXoOaVg9fpRwf8fEhF8lqfOJL1FpRihUlNxEa8kw-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "addConditionalFormatRule": {
        "rule": {
          "ranges": [
            {
              "sheetId": 1020069232,
              "startRowIndex": 10,
              "endRowIndex": 11
            }
          ],
          "gradientRule": {
            "minpoint": {
              "color": {
                "green": 0.2,
                "red": 0.8
              },
              "type": "MIN"
            },
            "maxpoint": {
              "color": {
                "green": 0.9
              },
              "type": "MAX"
            }
          }
        },
        "index": 0
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.deleteConditionalFormatRule

The deleteConditionalFormatRule method allows you to deletes a conditional format rule at the given index,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple deleteConditionalFormatRule operation within the spread sheet, need to repeat deleteConditionalFormatRule property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.deleteConditionalFormatRule configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.deleteConditionalFormatRule>

Sample request

The following request deletes the conditional formatting rule having index 0 in the sheet specified by sheetId.

{
    "clientId":"617729022812-vjo2edd0i4bcb38ifu4qg17ke5nn6f2m.apps.googleusercontent.com",
    "clientSecret":"ry_AXMsEe5Sn9iVoOY7ATnb8",
    "refreshToken":"1/Si2q4aOZsaMlYW7bBIoO-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-CA9sR2IXoOaVg9fpRwf8fEhF8lqfOJL1FpRihUlNxEa8kw-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "deleteConditionalFormatRule": {
        "sheetId": 1020069232,
        "index": 0
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

Data Manipulation Operations

googlespreadsheet.addRowsColumnsData

The addRowsColumnsData method allows you to add a new rows or columns of data to a sheet, see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
range	The A1 notation of the values to retrieve.	Yes.
insertDataOption	How the input data should be inserted. For more detail click here.	Optional.
valueInputOption	How the input data should be interpreted. For more detail click here.	Yes.
majorDimension	The major dimension that results should use. For more detail click here.	Optional.
fields	Specifying which fields to include in a partial response. For the following request only the updates will be included in the response.	Optional.
values	The data that was to be written. For more detail click here.	Optional.

Sample configurations

<googlespreadsheet.deleteDimension configKey="SpreadsheetConnection">
     <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
     <requests>{${payload.requests}}</requests>
     <fields>{${payload.fields}}</fields>
</googlespreadsheet.deleteDimension>

Sample request

The following request appends data in row major fashion. The range is used to search for existing data and find a "table" within that range. Values will be appended to the next row of the table, starting with the first column of the table.

{
    "clientId":"617729022812-xxxxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxxxxxxxxxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CxxxxxxxxxxxxxxxxxxxxxxxxxxdrXFGA",
    "range":"Sheet1!A1:B2",
    "insertDataOption":"INSERT_ROWS",
    "majorDimension":"ROWS",
    "valueInputOption":"RAW",
    "values":[
          [
               "20",
               "21"
           ],
           [
               "22",
              "23"
           ]
      ]
}

Sample response

The response include the updates details.

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CxxxxxxxxxxxxxxxxxxxxxxxxxxdrXFGA",
    "updates": {
        "spreadsheetId": "12KoqoxmykLLYbtsm6CxxxxxxxxxxxxxxxxxxxxxxxxxxdrXFGA",
        "updatedRange": "Sheet1!A1:B2",
        "updatedRows": 2,
        "updatedColumns": 2,
        "updatedCells": 4
    }
}

googlespreadsheet.sortRange

The sortRange method allows you to sorts data in rows based on a sort order per column,see the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple sortRange operation within the spread sheet, need to repeat sortRange property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.sortRange configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.sortRange>

Sample request

The following request sorts the range A1:F10, first by column B in ascending order, then by column D in descending order, then by column E in descending order.

{
    "clientId":"617729022812-xxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxx-kQ9Wri4bsf4TEulw",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "sortRange": {
        "range": {
          "sheetId": 1020069232,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 0,
          "endColumnIndex": 6
        },
        "sortSpecs": [
          {
            "dimensionIndex": 1,
            "sortOrder": "ASCENDING"
          },
          {
            "dimensionIndex": 3,
            "sortOrder": "DESCENDING"
          },
          {
            "dimensionIndex": 4,
            "sortOrder": "DESCENDING"
          }
        ]
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.copyRange

The copyRange method allows you to copy cell formatting in one range and paste it into another range on the same sheet. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple copyRange operation within the spread sheet, need to repeat copyPaste property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.copyRange configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.copyRange>

Sample request

The following request copies the formatting in range A1:D10 and pastes it to the F1:I10 range on the same sheet. The original values in A1:I10 remain unchanged.

{
    "clientId":"617729022812-xxxxxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"ry_AXMsEe5Sn9iVoOY7ATnb8",
    "refreshToken":"1/xxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.xxxxxxxxxxx-pOuVvnbnHhkVn5u8t6Qr",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA",
    "requests": [
    {
      "copyPaste": {
        "source": {
          "sheetId": 121832844,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 0,
          "endColumnIndex": 4
        },
        "destination": {
          "sheetId": 121832844,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 5,
          "endColumnIndex": 9
        },
        "pasteType": "PASTE_FORMAT",
        "pasteOrientation": "NORMAL"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}

googlespreadsheet.cutRange

The cutRange method allows you to cuts the one range and pastes its data, formats, formulas, and merges to the another range on the same sheet. See the Google Spreadsheet documentation.

Parameter Name	Description	Required
spreadsheetId	Unique value of the spreadsheet	Yes.
requests	It contains data that is a kind of update to apply to a spreadsheet. To perform multiple cutRange operation within the spread sheet, need to repeat cutPaste property within the requests property.	Yes.
fields (Outside the requests property)	Specifying which fields to include in a partial response.For the following request only the spreadsheetId will be included in the response.	Optional.

Sample configurations

<googlespreadsheet.cutRange configKey="SpreadsheetConnection">
    <spreadsheetId>{${payload.spreadsheetId}}</spreadsheetId>
    <requests>{${payload.requests}}</requests>
    <fields>{${payload.fields}}</fields>
</googlespreadsheet.cutRange>

Sample request

The following request cuts the range A1:D10 and pastes its data, formats, formulas, and merges to the F1:I10 range on the same sheet. The original source range cell contents are removed.

{
    "clientId":"617729022812-xxxxxxxxxxx.apps.googleusercontent.com",
    "clientSecret":"xxxxxxxxxxxxx",
    "refreshToken":"1/xxxxxxxxxxxxxx-fCyxRTyf-LpK6fDWF9DgcM",
    "accessToken":"ya29.Ci-xxxxxxxxxxxxx",
    "apiUrl":"https://sheets.googleapis.com/v4/spreadsheets",
    "spreadsheetId": "14PJALKcIXLr75rJWXlHhVjOt7z0Nby7AvcKXJGhMN2s",
    "requests": [
    {
      "cutPaste": {
        "source": {
          "sheetId": 1020069232,
          "startRowIndex": 0,
          "endRowIndex": 10,
          "startColumnIndex": 0,
          "endColumnIndex": 4
        },
        "destination": {
          "sheetId": 401088778,
          "rowIndex": 0,
          "columnIndex": 5
        },
        "pasteType": "PASTE_NORMAL"
      }
    }
  ],
  "fields": "spreadsheetId"
}

Sample response

{
    "spreadsheetId": "12KoqoxmykLLYbtsm6CEOggk5bTKMEIFGCD9EBdrXFGA"
}