View as Markdown
Google Docs icon

Google Docs ACTION

Append Text

Append text to the end of a Google Doc, or to the very beginning when Append at Beginning is set. Use when adding a line or paragraph to an existing document without choosing an exact character position. Use Insert Text instead when the text must land at a specific index, or when inserting into a particular tab. Use Find Document to resolve a document's name to its ID. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

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

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.

Append Text inputs
Property Type Description
docId 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
text Text string
Enter static text (e.g., hello world) or a reference to a string exported by a previous step (e.g., {{steps.foo.$return_value}}).
Required
appendAtBeginning Append at Beginning boolean
Whether to append at the beginning (true) of the document or at the end (false). Defaults to false
Optional
suggestMode Suggest Changes boolean
Make the change as a suggestion (Google Docs Suggesting mode) that the document's editors can accept or reject, instead of editing the document directly. The response's suggestionIds lists the suggestions the change created or extended - an edit next to an existing suggestion can join it rather than create a new one. Pass the IDs to Resolve Suggestions, or use List Suggestions to see every open suggestion. While a suggestion is open, the document text this returns shows the suggested and the original text side by side. Set true to propose the edit, or leave false (default) to edit directly.
Optional
fields Fields string
Optional Google Docs API field mask limiting which document fields are returned, e.g. documentId,title,revisionId instead of the whole document. Valid top-level fields: documentId, title, body, headers, footers, footnotes, documentStyle, suggestedDocumentStyleChanges, namedStyles, suggestedNamedStylesChanges, revisionId, suggestionsViewMode, commentsViewMode, inlineObjects, lists, positionedObjects, namedRanges, tabs - the underscore spelling of each (e.g. document_id) is accepted too. Nested selections are allowed, e.g. body/content. There is no url field, and an invalid mask fails the call before the document is changed. With a Tab ID, the mask is read against the document with its tabs: every content field (body, lists, inlineObjects, headers, footers, ...) sits under tabs rather than at the top level, and tabs is narrowed to that tab - pass documentId,revisionId for a minimal confirmation, or tabs for the written tab. Leave blank to return the full document - or, with a Tab ID, the whole written tab, which for a long tab can be very large; pass documentId,revisionId when you only need confirmation.
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-append-text
Version
0.3.0
App
Google Docs
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes