Google Docs

1. Overview

Google Docs is a cloud-based word processing application that allows for real-time collaboration and document creation. It is part of the free, web-based Google Docs Editors suite offered by Google.

The GoInsight Google Docs node enables you to integrate document management directly into your automated workflows. You can programmatically create, retrieve, and modify documents, streamlining processes like report generation, content management, and automated communication. Key capabilities include:

• Creating new blank documents with a specified title.
• Retrieving the full content and metadata of existing documents.
• Updating documents with text, formatting, and other structural changes.

2. Prerequisites

Before using this node, you will need to have a valid Google Docs account. You may also need appropriate permissions within your Google Cloud Platform project to create and manage the API credentials required to connect to the Google Docs API.

3. Credentials

For a detailed guide on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node provides operations to manage Google Docs documents. The table below summarizes the available actions.

Operation Details

Create a Document

Creates a new blank Google Docs document with an optional title. The document is saved to the user's root folder in Google Drive by default.

Options:

• Title: The title of the document to be created (optional, creates untitled document if empty)

Output:

• DocumentId (string): The unique identifier of the newly created document.
• DocumentUrl (string): The URL to access and edit the document.
• Title (string): The title of the document.
• RevisionId (string): The revision ID of the document (valid for 24 hours).
• StatusCode (number): The operation result code: -1 (parameter error), 200 (success), 500 (failure).
• ErrorMessage (string): Error description if the operation failed.

Get a Document

Retrieves the content and metadata of a specified Google Docs document by document ID.

Options:

• DocumentId: The unique identifier of the Google Docs document to retrieve

Output:

• DocumentId (string): The unique identifier of the document.
• Title (string): The title of the document.
• Body (object): The body content of the document (object containing content fields).
• RevisionId (string): The revision ID of the document.
• DocumentUrl (string): The URL to access and edit the document.
• StatusCode (number): The operation result code: -1 (parameter error), 200 (success), 500 (failure).
• ErrorMessage (string): Error description if the operation failed.

Update a Document

Updates a Google Docs document using the batchUpdate method, which allows applying one or more updates atomically. Supports various operations like inserting text, updating styles, managing tables, and more.

Options:

• DocumentId: The unique identifier of the Google Docs document to update
• RequestsJson: A JSON array string containing one or more update requests

Output:

• DocumentId (string): The unique identifier of the updated document.
• RevisionId (string): The revision ID of the document after the update.
• Replies (object-array): An array of replies from the API for each update request.
• DocumentUrl (string): The URL to access and edit the document.
• StatusCode (number): The operation result code: -1 (parameter error), 200 (success), 500 (failure).
• ErrorMessage (string): Error description if the operation failed.

5. Example Usage

This section will guide you through creating a simple workflow that automatically generates a new Google Docs document.

The workflow will consist of three nodes: Start -> Google Docs: Create a Document -> Answer.

Step-by-Step Guide

1. Add the Tool Node:
   • In your workflow canvas, click the + button to add a new node.
   • Select the "Tools" tab in the pop-up panel.
   • Find and select "Google Docs" from the list of available tools.
   • From the list of operations for Google Docs, click on "Create a Document" to add the node to your canvas.
2. Configure the Node:
   • Click on the newly added "Create a Document" node to open its configuration panel on the right.
   • Credentials: In the credentials field at the top of the panel, click the dropdown menu and select your pre-configured Google Docs credential.
   • Parameters: Locate the "Options" section to fill in the node's parameters.
   • Title: Enter a title for your new document. For example, you could type "Automated Weekly Report". If you leave this field blank, an "Untitled document" will be created.
3. Run and Validate:
   • Once the required parameters are filled, any error indicators on the workflow canvas should disappear.
   • Click the "Run" button in the top-right corner of the canvas to execute the workflow.
   • After a successful run, you can click the log icon (also in the top-right) to view the detailed inputs and outputs of the node. You should see the DocumentId and DocumentUrl of the newly created document in the output section.

After completing these steps, your workflow is fully configured. When executed, it will create a new document in your Google Drive with the title you specified.

6. FAQs

Q: I'm getting a 403 Forbidden error when the node runs. What's wrong?

A: A 403 error typically indicates a permissions issue with the Google API. Please check the following:

• Ensure the Google Docs API is enabled in your Google Cloud Platform project.
• Verify that your OAuth consent screen is properly configured and that your application has the necessary scopes (e.g., https://www.googleapis.com/auth/documents).
• Make sure the user account associated with the credential has permission to create or access documents.

Q: How can I find the DocumentId for an existing document?

A: You can find the DocumentId directly from the document's URL in your web browser. The URL structure is typically https://docs.google.com/document/d/DOCUMENT_ID/edit. The DocumentId is the long string of letters, numbers, and symbols between /d/ and /edit.

Q: What is the correct format for the RequestsJson parameter in the "Update a Document" operation?

A: The RequestsJson parameter expects a JSON string that represents an array of Request objects as defined by the official Google Docs API. Each object specifies a single update to perform. For example, to insert text at the beginning of a document, the JSON string would look like this: [{"insertText":{"location":{"index":1},"text":"Hello, World!"}}]. For a complete list of possible requests, please refer to the official API documentation.

7. Official Documentation

For more advanced use cases and detailed information about the API, please refer to the Google Docs API Official Documentation.