Google Sheets
Google Sheets is a cloud-based spreadsheet software that allows users to create, edit, and collaborate on spreadsheets in real-time.
Categories: Productivity and Collaboration
Type: googleSheets/v1
Connections
Version: 1
OAuth2 Authorization Code
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| clientId | Client Id | STRING | true | |
| clientSecret | Client Secret | STRING | true |
Connection Setup
Create OAuth 2.0 Application
Creation of OAuth 2.0 application is documented here.
Enable Google Sheets API
- In the Google Cloud Console, select your project.
- Go to the APIs & Services.
- Click on ENABLE APIS AND SERVICES.
- Search for "google sheets api" in the search bar.
- Click on Google Sheets API.
- Click Enable.
Enable Google Drive API
- In the Google Cloud Console, select your project.
- Go to the APIs & Services.
- Click on ENABLE APIS AND SERVICES.
- Search for "google drive api" in the search bar.
- Click on Google Drive API.
- Click Enable.
Actions
Clear Sheet
Name: clearSheet
Clear a sheet of all values while preserving formats.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetId | Sheet ID | INTEGER Depends OnspreadsheetId | The ID of the sheet. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
Example JSON Structure
{
"label" : "Clear Sheet",
"name" : "clearSheet",
"parameters" : {
"spreadsheetId" : "",
"sheetId" : 1,
"isTheFirstRowHeader" : false
},
"type" : "googleSheets/v1/clearSheet"
}Output
This action does not produce any output.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet ID
To find the Sheet ID, click here
Create Column
Name: createColumn
Append a new column to the end of the sheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| columnName | Column Name | STRING | Name of the new column. | true |
Example JSON Structure
{
"label" : "Create Column",
"name" : "createColumn",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"columnName" : ""
},
"type" : "googleSheets/v1/createColumn"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| spreadsheetId | STRING | ID of the spreadsheet. |
| sheetName | STRING | Name of the sheet. |
| headers | ARRAY Items[STRING] | List of headers on the sheet. |
Output Example
{
"spreadsheetId" : "",
"sheetName" : "",
"headers" : [ "" ]
}Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
Create Sheet
Name: createSheet
Create a blank sheet with title. Optionally, provide headers.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING | The name of the new sheet. | true |
| headers | Headers | ARRAY Items[STRING] | The headers of the new sheet. | false |
Example JSON Structure
{
"label" : "Create Sheet",
"name" : "createSheet",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"headers" : [ "" ]
},
"type" : "googleSheets/v1/createSheet"
}Output
Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| spreadsheetId | STRING | ID of the spreadsheet. |
| sheetName | STRING | Name of the sheet. |
| headers | ARRAY Items[STRING] | List of headers on the sheet. |
Output Example
{
"spreadsheetId" : "",
"sheetName" : "",
"headers" : [ "" ]
}Find Spreadsheet ID
To find the Spreadsheet ID, click here
Create Spreadsheet
Name: createSpreadsheet
Create a new spreadsheet in a specified folder.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| title | Title | STRING | Title of the new spreadsheet to be created. | true |
| folderId | Folder ID | STRING | ID of the folder where the new spreadsheet will be stored. If no folder is selected, the folder will be created in the root folder. | false |
Example JSON Structure
{
"label" : "Create Spreadsheet",
"name" : "createSpreadsheet",
"parameters" : {
"title" : "",
"folderId" : ""
},
"type" : "googleSheets/v1/createSpreadsheet"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Folder ID
To find the Folder ID, click here
Delete Column
Name: deleteColumn
Deletes column on an existing sheet. Remaining columns will be shifted to the left.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetId | Sheet ID | INTEGER Depends OnspreadsheetId | The ID of the sheet. | true |
| label | Column Label | STRING | The label of the column to be deleted. | true |
Example JSON Structure
{
"label" : "Delete Column",
"name" : "deleteColumn",
"parameters" : {
"spreadsheetId" : "",
"sheetId" : 1,
"label" : ""
},
"type" : "googleSheets/v1/deleteColumn"
}Output
This action does not produce any output.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet ID
To find the Sheet ID, click here
Delete Row
Name: deleteRow
Deletes row on an existing sheet. Remaining rows will be shifted up.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetId | Sheet ID | INTEGER Depends OnspreadsheetId | The ID of the sheet. | true |
| rowNumber | Row Number | INTEGER | The row number to delete. | true |
Example JSON Structure
{
"label" : "Delete Row",
"name" : "deleteRow",
"parameters" : {
"spreadsheetId" : "",
"sheetId" : 1,
"rowNumber" : 1
},
"type" : "googleSheets/v1/deleteRow"
}Output
This action does not produce any output.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet ID
To find the Sheet ID, click here
Delete Sheet
Name: deleteSheet
Delete a specified sheet from a spreadsheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetId | Sheet ID | INTEGER Depends OnspreadsheetId | The ID of the sheet. | true |
Example JSON Structure
{
"label" : "Delete Sheet",
"name" : "deleteSheet",
"parameters" : {
"spreadsheetId" : "",
"sheetId" : 1
},
"type" : "googleSheets/v1/deleteSheet"
}Output
This action does not produce any output.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet ID
To find the Sheet ID, click here
Find Row by Number
Name: findRowByNum
Get a row in a Google Sheet by row number.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
| rowNumber | Row Number | INTEGER | The row number to get from the sheet. | true |
Example JSON Structure
{
"label" : "Find Row by Number",
"name" : "findRowByNum",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"isTheFirstRowHeader" : false,
"rowNumber" : 1
},
"type" : "googleSheets/v1/findRowByNum"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Get Rows
Name: getRows
Get all rows from a Google Sheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
Example JSON Structure
{
"label" : "Get Rows",
"name" : "getRows",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"isTheFirstRowHeader" : false
},
"type" : "googleSheets/v1/getRows"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
Insert Multiple Rows
Name: insertMultipleRows
Append rows to the end of the spreadsheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| valueInputOption | Value Input Option | STRING OptionsRAW, USER_ENTERED | How the input data should be interpreted. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
| rows | DYNAMIC_PROPERTIES Depends OnspreadsheetId, sheetName, isTheFirstRowHeader | true |
Example JSON Structure
{
"label" : "Insert Multiple Rows",
"name" : "insertMultipleRows",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"valueInputOption" : "",
"isTheFirstRowHeader" : false,
"rows" : { }
},
"type" : "googleSheets/v1/insertMultipleRows"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
Insert Row
Name: insertRow
Append a row of values to an existing sheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| valueInputOption | Value Input Option | STRING OptionsRAW, USER_ENTERED | How the input data should be interpreted. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
| row | DYNAMIC_PROPERTIES Depends OnspreadsheetId, sheetName, isTheFirstRowHeader | true |
Example JSON Structure
{
"label" : "Insert Row",
"name" : "insertRow",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"valueInputOption" : "",
"isTheFirstRowHeader" : false,
"row" : { }
},
"type" : "googleSheets/v1/insertRow"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
List Sheets
Name: listSheets
Get all sheets from the spreadsheet.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
Example JSON Structure
{
"label" : "List Sheets",
"name" : "listSheets",
"parameters" : {
"spreadsheetId" : ""
},
"type" : "googleSheets/v1/listSheets"
}Output
Type: ARRAY
Items Type: OBJECT
Properties
| Name | Type | Description |
|---|---|---|
| spreadsheetId | STRING | ID of the spreadsheet. |
| sheetName | STRING | Name of the sheet. |
| headers | ARRAY Items[STRING] | List of headers on the sheet. |
Output Example
[ {
"spreadsheetId" : "",
"sheetName" : "",
"headers" : [ "" ]
} ]Find Spreadsheet ID
To find the Spreadsheet ID, click here
Update Row
Name: updateRow
Overwrite values in an existing row.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet ID | STRING | The ID of the spreadsheet to apply the updates to. | true |
| sheetName | Sheet Name | STRING Depends OnspreadsheetId | The name of the sheet. | true |
| rowNumber | Row Number | INTEGER | The row number to update. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
| updateWholeRow | Update Whole Row | BOOLEAN Optionstrue, false | Whether to update the whole row or just specific columns. | true |
| row | DYNAMIC_PROPERTIES Depends OnspreadsheetId, sheetName, isTheFirstRowHeader, updateWholeRow | true |
Example JSON Structure
{
"label" : "Update Row",
"name" : "updateRow",
"parameters" : {
"spreadsheetId" : "",
"sheetName" : "",
"rowNumber" : 1,
"isTheFirstRowHeader" : false,
"updateWholeRow" : false,
"row" : { }
},
"type" : "googleSheets/v1/updateRow"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
Triggers
New Row
Name: newRow
Triggers when a new row is added.
Type: DYNAMIC_WEBHOOK
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| spreadsheetId | Spreadsheet | STRING | The spreadsheet to apply the updates to. | true |
| isTheFirstRowHeader | Is the First Row Headers? | BOOLEAN Optionstrue, false | If the first row is header. | true |
| sheetName | Sheet | STRING Depends OnspreadsheetId | The name of the sheet | true |
Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
JSON Example
{
"label" : "New Row",
"name" : "newRow",
"parameters" : {
"spreadsheetId" : "",
"isTheFirstRowHeader" : false,
"sheetName" : ""
},
"type" : "googleSheets/v1/newRow"
}Find Spreadsheet ID
To find the Spreadsheet ID, click here
Find Sheet Name
To find the Sheet Name, click here
What to do if your action is not listed here?
If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.
To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.
Additional Instructions
How to find Spreadsheet ID
You can find your Spreadsheet ID in the URL of your Google Sheets document. For example, in the URL https://docs.google.com/spreadsheets/d/1fEIYXSdLufVgmOO2532dxaelu1J1bXXMNFFAS2DHFZuw/edit?gid=1579592398#gid=1579592398, the Spreadsheet ID is 1fEIYXSdLufVgmOO2532dxaelu1J1bXXMNFFAS2DHFZuw.
How to find Sheet ID
You can find your Sheet ID in the URL of your Google Sheets document. For example, in the URL https://docs.google.com/spreadsheets/d/1fEIYXSdLufVgmOO2532dxaelu1J1bXXMNFFAS2DHFZuw/edit?gid=1579592398#gid=1579592398, the Sheet ID is 1579592398.
How to find Sheet Name
You can find your Sheet name by looking at the Bottoms Tabs:
- Open your Google Sheets document.
- At the bottom left, you’ll see tabs like: (the tabs at the bottom of the screen that show the names of your sheets).
- The text on each tab is the sheet name.
- The highlighted tab is the currently active sheet.
How to find Folder ID
You can find your Folder ID in the URL of your Google Drive folder. For example, in the URL https://drive.google.com/drive/folders/1fEIYXSdLufVgmOO2532dxaelu1J1bXXMNFFAS2DHFZuw, the Folder ID is 1fEIYXSdLufVgmOO2532dxaelu1J1bXXMNFFAS2DHFZuw.
Troubleshooting
Access Blocked: Verification Process Not Completed
Documentation for how to add a test user can be found here
How is this guide?
Last updated on
Google Search Console
The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone).
Google Slides
Google Slides is a cloud-based presentation software that allows users to create, edit, and collaborate on presentations online in real-time.