TheFirestore - Batch Gettask 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.
Firestoreis 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 theFirestore - Batch Gettask:
Enable the Cloud Firestore API (firestore.googleapis.com).
Create anauthentication profile. Application Integration uses an authentication profile to connect to an authentication endpoint for theFirestore - Batch Gettask.
TheIntegrationspage appears listing all the integrations available in the Google Cloud project.
Select an existing integration or clickCreate integrationto create a new one.
If you are creating a new integration:
Enter a name and description in theCreate Integrationpane.
Select a region for the integration.
Select a service account for the integration. You can change or update the service account details of an integration any time from theinfoIntegration summarypane in the integration toolbar.
ClickCreate. The newly created integration opens in theintegration editor.
In theintegration editornavigation bar, clickTasksto view the list of available tasks and connectors.
Click and place theFirestore - Batch Getelement in the integration editor.
Click theFirestore - Batch Getelement on the designer to view theFirestore - Batch Gettask configuration pane.
Go toAuthentication, 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 profileand follow the steps as mentioned inCreate a new authentication profile.
Go toTask Input, and configure the displayed inputs fields using the followingTask input parameterstable.
Changes to the inputs fields are saved automatically.
Task input parameters
The following table describes the input parameters of theFirestore - Batch Gettask:
Property
Data type
Description
Region
String
Location of the Firestore database. For example,us-central1.
TheFirestore - Batch Gettask 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 atemporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, seeError handling strategies.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThe \u003cstrong\u003eFirestore - Batch Get\u003c/strong\u003e task allows for the retrieval of multiple Firestore documents with a single batch request.\u003c/p\u003e\n"],["\u003cp\u003eThis task is currently in a pre-GA (General Availability) stage, meaning it has limited support and is subject to the "Pre-GA Offerings Terms".\u003c/p\u003e\n"],["\u003cp\u003eBefore using the task, the Cloud Firestore API must be enabled, and an authentication profile needs to be created for secure connection.\u003c/p\u003e\n"],["\u003cp\u003eConfiguration involves selecting an existing integration, placing the \u003cstrong\u003eFirestore - Batch Get\u003c/strong\u003e task, selecting an authentication profile, and configuring input parameters such as Region, ProjectsId, DatabasesId, and Request.\u003c/p\u003e\n"],["\u003cp\u003eThe task output provides document data in a base64-encoded format that needs to be decoded.\u003c/p\u003e\n"]]],[],null,["# Firestore - Batch Get task\n\nSee the [supported connectors](/integration-connectors/docs/connector-reference-overview) for Application Integration.\n\nFirestore - Batch Get task\n==========================\n\n|\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nThe **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.\n\n[Firestore](/firestore/docs) is a NoSQL document database built for automatic scaling, high performance, and ease of application development.\n\nBefore you begin\n----------------\n\nEnsure that you perform the following tasks in your Google Cloud project before configuring the **Firestore - Batch Get** task:\n\n1. Enable the Cloud Firestore API (`firestore.googleapis.com`).\n\n\n [Enable the Cloud Firestore API](https://console.cloud.google.com/flows/enableapi?apiid=firestore.googleapis.com)\n2. Create an [authentication profile](/application-integration/docs/configuring-auth-profile#createAuthProfile). Application Integration uses an authentication profile to connect to an authentication endpoint for the **Firestore - Batch Get** task.\n\n For information about granting additional roles or permissions to a service account, see [Granting, changing, and revoking access](/iam/docs/granting-changing-revoking-access).\n\nConfigure the Firestore - Batch Get task\n----------------------------------------\n\n1. In the Google Cloud console, go to the **Application Integration** page.\n\n [Go to Application Integration](https://console.cloud.google.com/integrations)\n2. In the navigation menu, click **Integrations** .\n\n\n The **Integrations** page appears listing all the integrations available in the Google Cloud project.\n3. Select an existing integration or click **Create integration** to create a new one.\n\n\n If you are creating a new integration:\n 1. Enter a name and description in the **Create Integration** pane.\n 2. Select a region for the integration. **Note:** The **Regions** dropdown only lists the regions provisioned in your Google Cloud project. To provision a new region, click **Enable Region** . See [Enable new region](/application-integration/docs/enable-new-region) for more information.\n 3. Select a service account for the integration. You can change or update the service account details of an integration any time from the info **Integration summary** pane in the integration toolbar. **Note:** The option to select a service account is displayed only if you have enabled integration governance for the selected region.\n 4. Click **Create** . The newly created integration opens in the *integration editor*.\n\n\n4. In the *integration editor* navigation bar, click **Tasks** to view the list of available tasks and connectors.\n5. Click and place the **Firestore - Batch Get** element in the integration editor.\n6. Click the **Firestore - Batch Get** element on the designer to view the **Firestore - Batch Get** task configuration pane.\n7. Go to **Authentication** , and select an existing authentication profile that you want to use.\n\n 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](/application-integration/docs/configuring-auth-profile#createAuthProfile).\n8. Go to **Task Input** , and configure the displayed inputs fields using the following [Task input parameters](#params) table.\n\n Changes to the inputs fields are saved automatically.\n\nTask input parameters\n---------------------\n\n\nThe following table describes the input parameters of the **Firestore - Batch Get** task:\n\nTask output\n-----------\n\nThe **Firestore - Batch Get** task returns the document data in base64-encoded format. You must decode the base64-encoded value to get the output string.\n| **Tip:** You can base64-encode or decode data using the **base64** command on Linux or macOS, or the **Base64.exe** command on Windows. Programming and scripting languages typically include libraries for base64-encoding. For command-line examples, see [Decode base64](/text-to-speech/docs/base64-decoding#linux) in the Cloud Text-to-Speech documentation.\n\n\u003cbr /\u003e\n\nError handling strategy\n-----------------------\n\n\nAn error handling strategy for a task specifies the action to take if the task fails due to a [temporary error](/application-integration/docs/error-handling). 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](/application-integration/docs/error-handling-strategy).\n\nQuotas and limits\n-----------------\n\nFor information about quotas and limits, see [Quotas and limits](/application-integration/docs/quotas).\n\nWhat's next\n-----------\n\n- Add [edges and edge conditions](/application-integration/docs/edge-overview).\n- [Test and publish](/application-integration/docs/test-publish-integrations) your integration.\n- Configure a [trigger](/application-integration/docs/how-to-guides#configure-triggers).\n- Add a [Data Mapping task](/application-integration/docs/data-mapping-task).\n- See [all tasks for Google Cloud services](/application-integration/docs/how-to-guides#configure-tasks-for-google-cloud-services)."]]
