Firestore Import Actor

Imports data from an Apify dataset into a Google Cloud Firestore database.

Overview

This actor transfers records from a specified Apify dataset into a Firestore collection. It's designed to be triggered via webhook or direct API call, making it suitable for automation within Apify workflows or from external systems.

Key Features

• Direct Dataset to Firestore Transfer: Moves data from any Apify dataset into a Firestore collection.
• Multiple Trigger Methods: Can be executed via Apify webhook, Apify.call(), or a legacy PhantomJS crawler finish webhook.
• Simple Configuration: Requires only your Firestore project credentials and target collection name.

How to Use

You need your Apify API token and Firestore project credentials (apiKey, authDomain, projectId).

1. Using a Webhook (Actor/Task)

Set up a webhook (e.g., as a run or finish webhook) with this payload:

{
  "datasetId": "{{resource.defaultDatasetId}}",
  "apiKey": "<firestoreApiKey>",
  "authDomain": "<firestoreAuthDomain>",
  "projectId": "<firestoreProjectId>",
  "collectionName": "<firestoreCollectionName>"
}

Webhook URL: https://api.apify.com/v2/acts/drobnikj~firestore-import/runs?token=<yourApifyApiToken>

2. Calling from Another Actor

Use Apify.call() within your actor's code:

await Apify.call('drobnikj/firestore-import', {
  "datasetId": "<datasetId>",
  "apiKey": "<firestoreApiKey>",
  "authDomain": "<firestoreAuthDomain>",
  "projectId": "<firestoreProjectId>",
  "collectionName": "<firestoreCollectionName>"
});

3. Legacy PhantomJS Crawler Task

For a PhantomJS crawler's Finish webhook URL, use this JSON object as the webhook data:

{
  "apiKey": "<firestoreApiKey>",
  "authDomain": "<firestoreAuthDomain>",
  "projectId": "<firestoreProjectId>",
  "collectionName": "<firestoreCollectionName>"
}

The datasetId will be automatically inferred from the triggering task.

Input/Output

Input:
The actor requires an input object containing:
* datasetId (usually provided automatically via webhook): The ID of the Apify dataset to import from.
* apiKey: Your Firestore project's API key.
* authDomain: Your Firestore project's auth domain (typically "<projectId>.firebaseapp.com").
* projectId: Your Google Cloud Firestore project ID.
* collectionName: The name of the Firestore collection where data will be inserted.

Output:
The actor does not return a specific dataset. On successful execution, the records from the specified Apify dataset will be added to the designated Firestore collection. Check the actor run log for details and any error messages.