Skip to Content

Google Docs Get Docs Activity

Introduction

A Google Docs Get Docs activity, using its Google Docs connection, retrieves Google Docs documents and is intended to be used as a source to provide data in an operation.

Create a Google Docs Get Docs Activity

An instance of a Google Docs Get Docs activity is created from a Google Docs connection using its Get Docs activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an Activity Instance in Component Reuse.

An existing Google Docs Get Docs activity can be edited from these locations:

Configure a Google Docs Get Docs Activity

Follow these steps to configure a Google Docs Get Docs activity:

Step 1: Enter a Name

In this step, provide a name for the activity. Each user interface element of this step is described below.

Google Docs Get Docs Activity Configuration Step 1

  • Name: Enter a name to identify the activity. The name must be unique for each Google Docs Get Docs activity and must not contain forward slashes / or colons :.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

Google Docs Get Docs Activity Configuration Step 2

  • Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The Google Docs connector uses the Google Docs API v1. Refer to the API documentation for information on the schema nodes and fields.

    The request and response data schemas consist of these nodes and fields:

    • Request:

      Request Schema Field/Node Google API Field Notes
      item n/a Requests zero or more documents
      docid documentId Document ID of the Google Doc

    • Response:

      Response Schema Field/Node Google API Field Notes
      item n/a Returns zero or more documents
      docname title Title of the Google Doc
      content document.body.content Content of the body of the Google Doc
      errormsg n/a Error message returned (if any)

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Google Docs endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring a Google Docs Get Docs activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity Actions Menu in Connector Basics.

Google Docs Get Docs activities can be used as a source with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.