View as Markdown
Google Sheets icon

Google Sheets ACTION

Add Conditional Format Rule

Create conditional formatting with color scales or custom formulas. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Sheets account once, then configure and run Add Conditional Format Rule from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_sheets-add-conditional-format-rule",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_sheets: { authProvisionId: "apn_xxxxxxx" },
    drive: "Drive",
    sheetId: "Spreadsheet ID",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Add Conditional Format Rule inputs
Property Type Description
drive Drive string
Select a specific drive to search. Defaults to All Drives (My Drive and all Shared Drives you have access to) when no selection is made. To limit to your personal drive or a Shared Drive, select it from this list.
Optional Dynamic
sheetId Spreadsheet ID string
Select a spreadsheet or provide a spreadsheet ID
Required Dynamic
worksheetId Worksheet ID integer
Select a worksheet or provide a worksheet ID
Required Dynamic
range Range string
The range of cells to format (e.g., A1:A10)
Required
conditionType Validation Type string
The type of data condition
Required
conditionValues Condition Values string[]
Values for condition (e.g., color scales or custom formulas)
Required
formattingType Formatting Type string
Choose between boolean condition or gradient color scale
Required
rgbColor RGB Color object
The RGB color value (e.g., {"red": 1.0, "green": 0.5, "blue": 0.2})
Optional
textFormat Text Format object
The text format options
Optional
bold Bold boolean
Whether the text is bold
Optional
italic Italic boolean
Whether the text is italic
Optional
strikethrough Strikethrough boolean
Whether the text is strikethrough
Optional
interpolationPointType Interpolation Point Type string
The interpolation point type
Optional
index Index integer
The zero-based index of the rule
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_sheets-add-conditional-format-rule
Version
0.0.4
App
Google Sheets
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes