ÃÛ¶¹ÊÓƵ

Google Docs modules

The ÃÛ¶¹ÊÓƵ Workfront Fusion Google Docs modules enable you to monitor, create, edit and retrieve documents in your Google Docs and Google Docs (for Google Workspace users).

In order to use Google Docs with ÃÛ¶¹ÊÓƵ Workfront Fusion, it is necessary to have a Google account. If you don’t have a Google account yet, you can create one at the Google Account help page.

For instructions on creating a scenario, see the articles under Create scenarios: article index.

For information about modules, see the articles under Modules: article index.

Access requirements

Expand to view access requirements for the functionality in this article.

You must have the following access to use the functionality in this article:

table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
ÃÛ¶¹ÊÓƵ Workfront package Any
ÃÛ¶¹ÊÓƵ Workfront license

New: Standard

Or

Current: Work or higher

ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current: No Workfront Fusion license requirement

Or

Legacy: Workfront Fusion for Work Automation and Integration

Product

New:

  • Select or Prime Workfront package: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion.
  • Ultimate Workfront package: Workfront Fusion is included.

Or

Current: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion.

For more detail about the information in this table, see Access requirements in documentation.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

To use Google Docs modules, you must have a Google account.

Google Docs API information

The Google Docs connector uses the following:

Base URL
https://docs.googleapis.com/v1
API version
v1
API tag
v1.4.13

Google Docs modules and their fields

When you configure Google Docs modules, Workfront Fusion displays the fields listed below. Along with these, additional Google Docs fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another.

Map toggle

Document

Create a Document

This action module allows you to create a new document in the selected folder.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Name
Enter a name for the document.
Content
Enter the content of the document. You can include HTML to format the document.
Choose a Drive

Select the type of drive where you want to create a document.

  • My Drive

    In the New Document's Location field, select the folder where you want to create a document.

  • Shared With Me

    In the New Document's Location field, select the folder where you want to create a document.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where you want to create a document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Insert a Header
Enable this option to insert the header to the document, then enter or map the text of the header.
Insert a Footer
Enable this option to insert the footer to the document, then enter or map the text of the header.

Create a Document From a Template

This action module creates a copy of an existing template document and replaces any tags. This module also allows users to replace images with new images by URL.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Create a Document from a Template
  • By Mapping
    Select this option to map the document template.
  • By Dropdown
    Select this option to choose the document template from the drop-down menu.
Choose a Drive

Select the type of drive where your template is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

  • Shared With Me

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where your template is located.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Map the ID of the template if you have selected to By Mapping , or select the path to the template and the template.
Values

For each tag that you want to enter a value for, click Add item, enter the tag, and enter the value that will be entered instead of the tag in the new document.

  • Tags
    Enter the tags that are contained in the document template. Do not use {{}}. Example: use name instead of {{name}}.
  • Replaced Value
    Enter the value of the tag.

For example the {{name}} variable in the source document will be displayed as the name field here, where the value can be inserted, such as John.

Images Replacement

>For each tag that you want to enter a value for, click Add item, then enter the link to the Image Object ID and Image URL that will replace the current image.

Note: You can retrieve the image IDs by using Get a Document module, where the IDs are contained in the array Inline Object Array.

We recommend that you add ALT text to images in your Google document.

To add an ALT Text to the Google Docs image:

  1. Right click on the image.
  2. Select the ALT text option.
  3. Enter the ALT text in the Title field and click OK.

After the ALT text is added to the image, the ALT text is displayed in the field name in parentheses.

Title
Enter the name for the new document.
Choose a Drive

Select the type of drive where your template is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where you want the document to be created.

  • Shared With Me

    Select the folder where you want the document to be created.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where you want the document to be created.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Delete a Document

This action module deletes a document.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Choose a Drive

Select the type of drive where the document you want to delete is located.

  • My Drive

    Select the folder where the document you want to delete is located, then select the document.

  • Shared With Me

    Select the folder where the document you want to delete is located, then select the document.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to delete is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Shared Drive
Select the drive that contains the document you want to download, then select a document. This option is available if you have selected My Drive in the Choose a Drive field.
Document ID
Select or map the document you want to delete.

Download a Document

This action module converts and downloads the selected document.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Choose a Drive

Select the type of drive where the document you want to download is located.

  • My Drive

    In the Document ID field, select the folder where the document you want to download is located, then select the document.

  • Shared With Me

    In the Document ID field, select the folder where the document you want to download is located, then select the document.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to download is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Type
Select the target file format of the downloaded document.

Get Content of a Document

This action module retrieves a specified document.

You may need to extend your permissions.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Get Content of a Document
Select whether you want to map the document ID of the document or select the document from the drop-down menu manually.
Choose a Drive

Select the type of drive that contains the document you want to retrieve.

  • My Drive

    Select the folder that contains the document you want to retrieve.

  • Shared With Me

    Select the folder that contains the document you want to retrieve.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive that contains the document you want to retrieve.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Enter or select the document you want to retrieve.
Filter

Select the object you want to be returned in the module's output.

  • Image (default)
  • Drawing
  • Chart

Note:

For further mapping of these objects, please use the Inline Objects Array value in this module's output (instead of inlineObjects).

The Inline Objects Array objects are sorted in the same order they appear in the document. It will make any further processing easier.

Insert a Paragraph to a Document

This action module appends or inserts a new paragraph to an existing document.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Select a Document
  • By Mapping
    Select this option to map the document.
  • By Dropdown
    Select this option to choose the document from the drop-down menu.
Choose a Drive

Select the type of drive where the document you want to add a paragraph to is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where the document you want to add a paragraph to is located.

  • Shared With Me

    Select the folder where the document you want to add a paragraph to is located.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to add a paragraph to is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Map or select the document where you want to insert text.
Insert a Paragraph

Select how you want the new text to be inserted in the document.

  • By specification of location

    • By index

      • Index

        Enter the Index number where you would like to insert your text. You can use the Get a Document module to retrieve Index number.

      • Inserted text

        Enter the text you want to insert to the document.

    • By segment ID

      Select the header and footer you want to insert the text content to and enter the text you want to insert to the corresponding fields.

      If the header or footer already contains text, the new text will be added before the existing text.

  • By appending to the body of the document

    Appends entered text at the end of the document's body content.

    The style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets.

  • By appending to the end of segment (Header and Footer)

    Select the header and footer you want to insert the text content to and enter the text you want to insert to the corresponding fields.

    If the header or footer already contain text, the new text will be added after the existing text.

Appended Text
Enter or map the text you want to append to the document

Insert an Image to a Document

This action module inserts an image from the URL to the document.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Select a Document
  • By Mapping
    Select this option to map the document template.
  • By Dropdown
    Select this option to choose the document from the drop-down menu.
Choose a Drive

Select the type of drive where the document you want to add an image to is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where the document you want to add an image to is located.

  • Shared With Me

    Select the folder where the document you want to add an image to is located.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to add an image to is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Map or select the document where you want to insert an image.
Insert an Image

Select how you want the new image to be inserted in the document.

  • By specification of location

    • By index

      • Index

        Enter the Index number where you would like to insert your image. You can use the Get a Document module retrieve Index number.

      • Image URL

        Enter the URL of the image you want to insert to the document.

        The maximum image size is 50 MB. Must not exceed 25 megapixels. Only PNG, JPEG, or GIF format is supported.

    • By segment ID

      Select the header and footer you want to insert the image to and enter the image URL to the corresponding fields.

      The maximum image size is 50 MB. The image must not exceed 25 megapixels. Only PNG, JPEG, or GIF format is supported.

  • By appending to the body of the document

    Appends a specific image at the end of the document's body content.

  • By appending to the end of segment (Header and Footer)

    Select the header and footer you want to insert an image to and enter the image URL you want to insert to the corresponding fields.

Height Magnitude in Points/Width Magnitude in Points
Define the height or width of the inserted image. The aspect ratio will be kept.

List Documents

This action module retrieves a list of documents from the selected folder.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Choose a Drive

Select the type of drive you want to list documents from.

  • My Drive

    Select the folder you want to list documents from.

  • Shared With Me

    Select the folder you want to list documents from.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive you want to list documents from.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Limit
Set the maximum number of documents Workfront Fusion returns in one execution cycle.

Replace Text in a Document

This action module replaces text in a document.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Select a Document
  • By Mapping
    Select this option to map the document template.
  • By Dropdown
    Select this option to choose the document from the drop-down menu.
Choose a Drive

Select the type of drive where the document you want to add text to is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where the document you want to add text to is located, then select the document.

  • Shared With Me

    Select the folder where the document you want to add text to is located, then select the document.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to add text to is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Map or select the document where you want to replace text.
Replace a Text

For each piece of text you want to replace, click Add item and enter the following:

  • Old text to be replaced

    Enter the text you want to replace.

  • New text to be inserted

    Enter the new text.

Replace an Image with a New Image

This action module replaces an existing image. The aspect ratio of the original image will be maintained.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Select a Document
  • By Mapping
    Select this option to map the document template.
  • By Dropdown
    Select this option to choose the document from the drop-down menu.
Choose a Drive

Select the type of drive where the document you want to replace an image is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where the document you want to replace an image is located, then select the document.

  • Shared With Me

    Select the folder where the document you want to replace an image is located, then select the document.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to replace an image is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Document ID
Map or select the document where you want to replace an image.
Images replacement

For each image you want to replace, click Add item and enter the existing image ID, then enter or map the URL of the new image that will replace the existing image.

Images are listed in the order they appear in the document. For example, Body: Image No. 1 is the first image in the document.

Watch Documents

This trigger module returns document details when a new document is created or modified in the selected folder.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Watch Documents
Select whether you want to watch created (By Created Date) or modified (By Modified Date) documents.
Choose a Drive

Select the type of drive you want to monitor.

  • My Drive

    Select the folder you want to watch for created or modified documents.

  • Shared With Me

    Select the folder you want to watch for created or modified documents.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive you want to watch.

    Note: If you have selected the Google Shared Drive option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Limit
Set the maximum number of documents Workfront Fusion returns in one execution cycle.

Other

This action module finds all links in the document and makes them clickable.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
Make All Links in a Document
  • By Mapping
    Select this option to map the document template.
  • By Dropdown
    Select this option to choose the document from the drop-down menu.
Choose a Drive

Select the type of drive where the document you want to make links clickable in is located. This option is available if you selected By Dropdown in the previous field.

  • My Drive

    Select the folder where the document you want to make links clickable in is located.

  • Shared With Me

    Select the folder where the document you want to make links clickable in is located.

  • Google Shared Drive (available for Google Workspace users only)

    Select whether you want to Use Domain Admin Access. Selecting Yes issues the request as a domain administrator, and all shared drives in which the requester is an administrator are returned.

    Select the shared drive where the document you want to make links clickable in is located, then select the document.

    Note: If you have selected the Google Docs option in this field and you are not a Google Workspace user, the error [400] Invalid Value is returned.

Shared Drive
Select the drive that contains the document you want to update links in, then select a document. This option is available if you have selected My Drive in the Choose a Drive field.
Document ID
Select or map the document you want to update the links in.

Make an API Call

This action module allows you to perform a custom API call.

Connection
For instructions about connecting your Google account to Workfront Fusion, see Create a connection - Basic instructions.
URL
Enter a path relative to https://docs.googleapis.com/. Example: /v1/documents/{presentationID}.
Method
Select the HTTP request method you need to configure the API call. For more information, see HTTP request methods.
Headers
Add the headers of the request in the form of a standard JSON object. For example, {"Content-type":"application/json"}. Workfront Fusion adds the authorization headers for you.
Query String
Enter the request query string.
Body

Add the body content for the API call in the form of a standard JSON object.

Note:

When using conditional statements such as if in your JSON, put the quotation marks outside of the conditional statement.

recommendation-more-help

Example: The following API call retrieves the details for the specified document in your Google Docs:

URL:

/v1/documents/1ujkf-GDgB0TQSYPrxbCSK4Uso54tHVMqHZEVZZxB6aY

Method:

GET

API call example

Details of the retrieved document can be found in the module’s Output under Bundle > Body.

API call output

7e1891ad-4d59-4355-88ab-a2e62ed7d1a3