See the supported connectors for Application Integration.

Firestore - Batch Get task

The Firestore - Batch Get task lets you send a single batch request to Cloud Firestore to get or retrieve the contents of multiple Firestore documents. Retrieved documents might not in the same order as they were requested.

Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.

Before you begin

Ensure that you perform the following tasks in your Google Cloud project before configuring the Firestore - Batch Get task:

  1. Enable the Cloud Firestore API (

    Enable the Cloud Firestore API

  2. Create an authentication profile. Application Integration uses an authentication profile to connect to an authentication endpoint for the Firestore - Batch Get task.

    For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.

Configure the Firestore - Batch Get task

  1. In the Google Cloud console, go to the Application Integration page.

    Go to Application Integration

  2. In the navigation menu, click Integrations.

    The Integrations page appears listing all the integrations available in the Google Cloud project.

  3. Select an existing integration or click Create integration to create a new one.

    If you are creating a new integration:

    1. Enter a name and description in the Create Integration pane.
    2. Select a region for the integration.
    3. Select a service account for the integration. You can change or update the service account details of an integration any time from the Integration summary pane in the integration toolbar.
    4. Click Create.

    This opens the integration in the integration editor.

  4. In the integration editor navigation bar, click Tasks to view the list of available tasks.
  5. Click and place the Firestore - Batch Get element in the integration editor.
  6. Click the Firestore - Batch Get element on the designer to view the Firestore - Batch Get task configuration pane.
  7. Go to Authentication, and select an existing authentication profile that you want to use.

    Optional. If you have not created an authentication profile prior to configuring the task, Click + New authentication profile and follow the steps as mentioned in Create a new authentication profile.

  8. Go to Task Input, and configure the displayed inputs fields using the following Task input parameters table.

    Changes to the inputs fields are saved automatically.

Task input parameters

The following table describes the input parameters of the Firestore - Batch Get task:

Property Data type Description
Region String Location of the Firestore database. For example, us-central1.
ProjectsId String Your Google Cloud project ID.
DatabasesIdString ID of the Firestore database.
Request JSON See request JSON structure.

Task output

The Firestore - Batch Get task returns the document data in base64-encoded format. You must decode the base64-encoded value to get the output string.

Error handling strategy

An error handling strategy for a task specifies the action to take if the task fails due to a temporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see Error handling strategies.

What's next

  1. Add edges and edge conditions.
  2. Test and publish your integration.
  3. Configure a trigger.
  4. Add a Data Mapping task.
  5. See all tasks for Google Cloud services.