Skip to Content

Google Drive List Files Activity

Introduction

A Google Drive List Files activity, using its Google Drive connection, retrieves a list of files (matching a query) from Google Drive and is intended to be used as a source to provide data in an operation.

Note

To use the List Files activity, you must grant access to these Google Drive scopes (as described in Google Drive Prerequisites):

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.photos.readonly

  • Create a Google Drive List Files Activity

    An instance of a Google Drive List Files activity is created from a Google Drive connection using its List Files 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 Drive List Files activity can be edited from these locations:

    Configure a Google Drive List Files Activity

    Follow these steps to configure a Google Drive List Files activity:

    Step 1: Enter a Name and Specify a Query

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

    Google Drive List Files Activity Configuration Step 1

    Tip

    Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

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

    • Drives to Search: From the menu, select a Google Drive to search within.

    • Query: Optionally, enter a query string. The list returned will contain only files that match the query.

    • Include items from all drives: Select to include files from shared drives in this activity's response.

    • Support all drives: Select to access shared drives when using this activity. If unselected, only My Drive will be accessible.

    • 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 Drive List Files Activity Configuration Step 2

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

      Note

      Data supplied in a transformation takes precedence over the activity configuration.

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

    • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the Google Drive 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 Drive List Files 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 Drive List Files 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.