View as Markdown
Google Docs icon

Google Docs ACTION

Replace Text

Find and replace all occurrences of a string in a Google Doc. Set Replacement Format to markdown to convert Markdown in the replacement into native Google Docs formatting. Use Find Document to resolve a document's name to its ID. Returns the number of replacements made. In a multi-tab document the replacement runs across every tab by default; set Tab ID to confine it to one tab, using List Tabs to get the IDs. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Docs account once, then configure and run Replace Text 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_docs-replace-text",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_docs: { authProvisionId: "apn_xxxxxxx" },
    documentId: "Document ID",
    find: "Find",
  },
})

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.

Replace Text inputs
Property Type Description
documentId Document ID string
The ID of the Google Doc. This is the long string in the document's URL: https://docs.google.com/document/d/{DOCUMENT_ID}/edit. Use Find Document to resolve a document's name to its ID.
Required
find Find string
The text to search for.
Required
replace Replace string
The text to replace each match with.
Required
format Replacement Format string
How to interpret the replacement text. plain inserts it exactly as typed (default). markdown converts Markdown syntax (bold, italic, inline code, links, headings, bullet and numbered lists) into native Google Docs formatting. Note that block-level Markdown (headings, lists) restyles the entire paragraph containing the match, since Google Docs applies paragraph styles per paragraph.
Optional
matchCase Match Case boolean
Case sensitive search (true) or not (false). Defaults to false
Optional
tabId Tab ID string
For a multi-tab document, confine the replacement to this tab (e.g. t.0). Get tab IDs from List Tabs. Omit to replace in every tab.
Optional

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_docs-replace-text
Version
1.2.0
App
Google Docs
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes