Skip to content

Google Sheets Integration with Orkes Conductor

Available since

  • v5.3.0 and later

Integrating Google Sheets with Orkes Conductor lets you build workflows that interact with your Google Sheets using the following operations:

  • Create Spreadsheet
  • Delete Spreadsheet
  • Append Values
  • Append Row
  • Append or Update Row
  • Read Values
  • Get Row
  • Update Row
  • Clear Range
  • Clear Sheet
  • Create Sheet
  • Delete Sheet
  • Delete Rows or Columns

This guide explains how to set up and use the integration. Here’s an overview:

  1. Get the required credentials from Google Console.
  2. Configure a new Google Sheets integration in Orkes Conductor.
  3. Use Google Sheets integration in workflows.

Step 1: Get the Google Console credentials

To integrate Google Sheets with Orkes Conductor, retrieve the OAuth client ID and secret from the Google console, and enable the Google Sheets API and Google Drive API.

Get OAuth Client credentials

To get the credentials:

  1. Go to the Google Cloud Console.
  2. Select your project or create a new one.
  3. In the left navigation menu, go to APIs & Services > Credentials
  4. Select + Create credentials > OAuth client ID.
  5. Choose your application type as Web application, and enter a Name.
  6. In Authorized redirect URIs, select +Add URI and enter your redirect URI in the format https://<YOUR-CONDUCTOR-CLUSTER-NAME>/integrations/oauth/callback.
  7. Select + Create.
  8. Note the generated OAuth Client ID and secret, or download and save the JSON.

Enable Google Sheets API

To enable Google Sheets API access:

  1. Go to APIs & Services > Enabled APIs & services.
  2. Select + Enable APIs and services.
  3. Search for Google Sheets API and enable it.

Enable Google Drive API

Note

This is required only if you want to use the Read & Write + Drive scope for spreadsheet deletion.

To enable Google Drive API access:

  1. Go to APIs & Services > Enabled APIs & services.
  2. Select + Enable APIs and services.
  3. Search for Google Drive API and enable it.

Step 2: Add an integration for Google Sheets

After obtaining the credentials, add a Google Sheets integration to your Conductor cluster.

To create an integration:

  1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
  2. Select + New integration.
  3. In the Productivity section, choose Google Sheets.
  4. Select + Add and enter the following parameters:
Parameter Description Required/Optional
Integration name A name for the integration. Required.
Scope The OAuth2 scope for Google Sheets API access. The scope you select determines the level of access Google grants to the integration. Supported values:
  • Read Only: Grants read-only access to sheets.
  • Read & Write: Grants full read and write access to sheets.
  • Read & Write + Drive: Grants full read and write access to sheets and drive. This is required for spreadsheet deletion permission.
 Required.
OAuth Client ID The OAuth client ID generated from Step 1. Required.
OAuth Client Secret The OAuth client secret generated from Step 1. Required.
Default Spreadsheet Id The default spreadsheet ID to use. To get the spreadsheet ID, open the spreadsheet in Google Sheets. The ID is the string of characters at the end of the URL: https://docs.google.com/spreadsheets/d/<YOUR-SPREADSHEET-ID>/. Optional.
Description A description of the integration. Required.
  1. (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
  2. Select Save.

This takes you to the Google sign-in page, where you can authorize the connection with your Google account. Once authorized, the integration is created successfully.

Step 3: Use Google Sheets integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use Google Sheets integration in a workflow:

  1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
  2. Select + Define workflow.
  3. In your workflow, select the (+) icon and select Connected Apps.
  4. In Add Task panel on the right, search for Google Sheets, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation Description Supported Integration Scopes
Create Spreadsheet Create a new Google Sheets spreadsheet with the provided title.
  • Read & Write + Drive
  • Read & Write
Delete Spreadsheet Delete an entire spreadsheet by ID.
  • Read & Write + Drive
Append Values Append multiple rows to a specified range in a sheet.
  • Read & Write + Drive
  • Read & Write
Append Row Append a single row to a sheet.
  • Read & Write + Drive
  • Read & Write
Append or Update Row Append a row if it doesn't exist, or update it if it does.
  • Read & Write + Drive
  • Read & Write
Read Values Read values from a specified range in a sheet.
  • Read & Write + Drive
  • Read & Write
  • Read Only
Get Rows Read all rows from a sheet.
  • Read & Write + Drive
  • Read & Write
  • Read Only
Update Row Update a specific row by index.
  • Read & Write + Drive
  • Read & Write
Clear Range Clear values from a specified range in a sheet.
  • Read & Write + Drive
  • Read & Write
Clear Sheet Clear all values from a sheet while keeping the sheet structure.
  • Read & Write + Drive
  • Read & Write
Create Sheet Create a new sheet (tab) within a spreadsheet.
  • Read & Write + Drive
  • Read & Write
Delete Sheet Delete a sheet (tab) from a spreadsheet.
  • Read & Write + Drive
  • Read & Write
Delete Rows or Columns Delete a range of rows or columns from a sheet.
  • Read & Write + Drive
  • Read & Write
  1. Select the required operation, configure the parameters, and select Save > Confirm.
  2. Select Execute to run the workflow.

For the complete operations parameters and output reference, see Google Sheets Operations Reference.