Skip to main content

Google Docs

Type ID: googleDocs  ·  Kind: Action  ·  Ports: 1 in, 1 out

Create and update documents using the Google Docs API.

Credentials​

Google Docs

Resources & operations​

  • Document (document)
    • Create (create) - Create a document
    • Get (get) - Fetch a document
    • Replace Text (replaceText) - Replace all matching text in a document
    • Append Text (appendText) - Append text to the end of a document

Properties​

Common​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
ResourceresourceoptionsNodocumentDocument (document)-
OperationoperationoptionsNocreateCreate (create), Get (get), Replace Text (replaceText), Append Text (appendText)resource = document

Document → Create​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
TitletitlestringYes''Title for the new Google documentresource = document, operation = create

Document → Get​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Document IDdocumentIdstringYes''Google Docs document IDresource = document, operation = get
Include Tabs ContentincludeTabsContentbooleanNotruetrue / falseresource = document, operation = get
FieldsfieldsstringNo''Optional response field mask (e.g. title,revisionId,body.content)resource = document, operation = get

Document → Replace Text​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Document IDdocumentIdstringYes''Google Docs document IDresource = document, operation = replaceText
Search TextsearchTextstringYes''Exact placeholder or text to replaceresource = document, operation = replaceText
Replacement TextreplacementTextstringNo''Text to replace every matching occurrence withresource = document, operation = replaceText
Additional FieldsadditionalFieldsobjectNo{}Collection (see below)resource = document, operation = replaceText

additionalFields collection options (Replace Text):

PropertyKeyTypeRequiredDefaultPossible values
Match CasematchCasebooleanNotruetrue / false
Required Revision IDrequiredRevisionIdstringNo''Fail if the document revision does not match this revision id
Target Revision IDtargetRevisionIdstringNo''Apply the change against this target revision id when possible

Document → Append Text​

PropertyKeyTypeRequiredDefaultPossible valuesApplies when
Document IDdocumentIdstringYes''Google Docs document IDresource = document, operation = appendText
TexttextstringYes''Text to append at the end of the documentresource = document, operation = appendText
Additional FieldsadditionalFieldsobjectNo{}Collection (see below)resource = document, operation = appendText

additionalFields collection options (Append Text):

PropertyKeyTypeRequiredDefaultPossible values
Required Revision IDrequiredRevisionIdstringNo''Fail if the document revision does not match this revision id
Target Revision IDtargetRevisionIdstringNo''Apply the change against this target revision id when possible

Notes​

  • Title is required for Create; Document ID is required for Get, Replace Text, and Append Text; Search Text is required for Replace Text; Text is required for Append Text.
  • Create/Get output: { success, documentId, title, revisionId, document }.
  • Replace Text output: { success, documentId, occurrencesChanged, replies, response }.
  • Append Text output: { success, documentId, replies, response }.