Skip to main content

Google Sheets Connector

Google Sheets Google Sheets is a cloud-based spreadsheet service from Google. This component allows you to create and manage spreadsheets, manipulate sheets and rows, and read cell data within Google Drive.

API Documentation

This component was built using the Google Sheets API v4. Additional information can be found in the Google Sheets API Guides.

Connections

Google Sheets OAuth 2.0

Authenticate requests to Google Sheets using values obtained from the Google Cloud Platform.

The Google Sheets component authenticates requests through the Google Cloud Platform (GCP) OAuth 2.0 service. A GCP OAuth 2.0 app is required for the integration to authenticate and perform Google Sheets tasks on behalf of users.

Prerequisites

Setup Steps

To create a Google Sheets OAuth 2.0 app:

  1. Open the Google Sheets API console at https://console.cloud.google.com/apis/api/sheets.googleapis.com.
  2. Click CREATE PROJECT to create a new GCP project, or select an existing project.
  3. Enable the Google Sheets API for the project by clicking ENABLE.
  4. On the sidebar, select Credentials.
  5. Configure the OAuth 2.0 Consent Screen by clicking CONFIGURE CONSENT SCREEN.
    1. Choose a User Type of External so the app will be available to users outside the organization.
    2. Fill out the OAuth consent screen with an app name, support email, and other required information.
    3. On the Scopes page, add the necessary scopes (see scope configuration below).
    4. Enter test users for testing purposes. The app will only work for those testing users until it is published.
    5. When ready for production, click PUBLISH APP on the OAuth consent screen to allow users to authorize the integration.
  6. Once the consent screen is configured, open the Credentials page from the sidebar.
  7. Click +CREATE CREDENTIALS and select OAuth client ID.
    1. Under Application type select Web application.
    2. Under Authorized redirect URIs enter the OAuth 2.0 callback URL: https://oauth2.integrations.acme.com/callback
    3. Click CREATE.
  8. Copy the Client ID and Client Secret that are generated.

Configure the Connection

  • Enter the Client ID and Client Secret from the OAuth app credentials.
  • For Scopes, use the following value:
    https://www.googleapis.com/auth/spreadsheets https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/drive.readonly
    • The spreadsheets scope allows full access to Google Sheets.
    • The drive.file scope allows access to files created or opened by the integration.
    • The drive.readonly scope allows read-only access to Drive metadata.
    • Refer to Google's OAuth 2.0 Scopes for Google APIs for additional scope information.

App Verification

Google requires OAuth apps that request access to user data to pass a verification review before being deployed at scale. This process ensures the app complies with Google's API Services User Data Policy, accurately represents its functionality, and handles user data responsibly.

Google OAuth apps pass through three stages before they are ready for production use.

Testing (unpublished): The app is only accessible to users manually added as test users in the OAuth consent screen. Up to 100 test users are allowed — all other users receive an error. This is the expected state during initial development.

Published, unverified: After publishing the app, all Google users can authenticate. However, for sensitive scopes, users see a "This app isn't verified" warning. Users can proceed by clicking AdvancedGo to [app name] (unsafe), but this warning reduces trust and may be blocked by organizations with strict Google Workspace policies.

Verified: Google has reviewed and approved the app. No warning is shown. Verification is required before deploying to production users.

Publishing the App

Publishing is required before any users outside the test list can authenticate:

  1. In the Google Cloud Console, navigate to APIs & ServicesOAuth consent screen
  2. Click PUBLISH APP and confirm

Requesting Verification

The scopes used by this component are classified as sensitive by Google. Submitting for verification removes the "This app isn't verified" warning:

  1. On the OAuth consent screen, click Prepare for verification
  2. Provide a privacy policy URL, authorized domain, and app logo
  3. Submit for review — Google typically responds within several weeks

Refer to Google's OAuth consent screen documentation for the full verification requirements.

This connection uses OAuth 2.0, a common authentication mechanism for integrations. Read about how OAuth 2.0 works here.

InputCommentsDefault
ScopesSpace-delimited list of OAuth scopes to request. Common scopes include spreadsheets (read/write), drive.file (create/edit files), and drive.readonly. Learn morehttps://www.googleapis.com/auth/spreadsheets https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/drive.readonly
Client IDClient ID from your Google Cloud Console OAuth credentials. Learn more
Client SecretClient Secret generated in your Google Cloud Console OAuth credentials. Learn more

Triggers

Spreadsheet Change Events

Receive change notifications for a Google Spreadsheet. Automatically creates and manages a Google Drive push notification subscription when the instance is deployed, and removes the subscription when the instance is deleted.

InputCommentsDefault
ConnectionThe Google Sheets connection to use.
Spreadsheet IDThe spreadsheet to monitor for changes.

Actions

Add Worksheet

Add a new Worksheet to a Google Sheet Document

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
Column HeadingsAn array of strings representing the column header names.
ConnectionThe Google Sheets connection to use.

Append Rows

Append new rows to a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
RowsAn array of row data. Can be an array of arrays (e.g., [[1,2,3], [4,5,6]]) or an array of objects where keys are column headers (e.g., [{"Column 1": "a"}]).
Store Raw ValuesWhen true, stores values exactly as provided without conversion. When false, values are converted as if typed into the spreadsheet (e.g., "=SUM(A1:A5)" becomes a formula).false
ConnectionThe Google Sheets connection to use.

Clear Worksheet

Clear all data in the a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
ConnectionThe Google Sheets connection to use.

Create Spreadsheet

Create a new Google Sheet Document

InputCommentsDefault
Document TitleSpecifies the title of the document.
ConnectionThe Google Sheets connection to use.

List Columns

Get the headers of a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
ConnectionThe Google Sheets connection to use.

List Rows

List the cell values of rows in a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
LimitThe maximum number of rows to retrieve.100
OffsetThe number of rows to skip from the top of the worksheet.0
ConnectionThe Google Sheets connection to use.

List Worksheets

List information about all Worksheets in a Google Sheet Document

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
ConnectionThe Google Sheets connection to use.

Raw Request

Send raw HTTP request to Google Sheets

InputCommentsDefault
ConnectionThe Google Sheets connection to use.
URLInput the path only (/v4/spreadsheets/{spreadsheetId}), The base URL is already included (https://sheets.googleapis.com). For example, to connect to https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}, only /v4/spreadsheets/{spreadsheetId} is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Remove Worksheet

Remove a Worksheet from a Google Sheet Document

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
ConnectionThe Google Sheets connection to use.

Set Header Row

Set the column headings in a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
Column HeadingsAn array of strings representing the column header names.
ConnectionThe Google Sheets connection to use.

Update Rows

Update call values of rows in a Worksheet

InputCommentsDefault
Spreadsheet IDThe unique identifier of the spreadsheet. You can find the spreadsheet ID in the URL: https://docs.google.com/spreadsheets/d/SPREADSHEET_ID/edit
Worksheet TitleThe title of the worksheet within the spreadsheet.
ValuesAn object where keys are row numbers and values are objects mapping column names to cell values.
Store Raw ValuesWhen true, stores values exactly as provided without conversion. When false, values are converted as if typed into the spreadsheet (e.g., "=SUM(A1:A5)" becomes a formula).false
ConnectionThe Google Sheets connection to use.