{ "openapi": "3.0.1", "info": { "title": "Firestore Import", "description": "Seamlessly import data from Apify datasets into Firebase Firestore database. This integration allows full control over document IDs, conflict resolution (overwrite, merge, skip), and data transformation using a custom JavaScript function.", "version": "0.0", "x-build-id": "HKRKFVHz930F7S76y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/apify~firestore-import/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-apify-firestore-import", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/apify~firestore-import/runs": { "post": { "operationId": "runs-sync-apify-firestore-import", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/apify~firestore-import/run-sync": { "post": { "operationId": "run-sync-apify-firestore-import", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "serviceAccountKey", "collection", "datasetId", "databaseName", "documentConflictResolution", "batchSize" ], "properties": { "serviceAccountKey": { "title": "Service Account Key", "type": "string", "description": "Service account key in JSON format. You can get it from *Firebase Console* -> *Project Settings* -> *Service accounts* -> *Generate new private key*. Paste the whole JSON string here." }, "datasetId": { "title": "Dataset ID", "type": "string", "description": "ID of the Apify dataset to import data from." }, "collection": { "title": "Collection", "type": "string", "description": "Firestore collection to import data to. If it doesn't exist, it will be created. Note: you can customize the collection for each document using the `transformFunction` input. This can be useful when you want to import data to sub-collections." }, "databaseName": { "title": "Database Name", "type": "string", "description": "Name of the Firestore database. If not provided, the default database (`\"(default)\"`) will be used.", "default": "(default)" }, "idField": { "title": "ID Field", "type": "string", "description": "Field in the dataset item that will be used as a Firestore document ID. If not provided, all documents will be created with a random ID generated by Firestore (it means that value of `documentConflictResolution` is ignored in that case). This is useful when you want to update existing documents in Firestore. Note: you can customize the ID for each document independently using the `transformFunction` input field." }, "documentConflictResolution": { "title": "Document Conflict Resolution", "enum": [ "overwrite", "merge", "skip" ], "type": "string", "description": "How to handle conflicts when importing data to Firestore:\n- *overwrite*: replace existing Firestore documents with the same ID.\n- *merge*: merge data from the dataset items with existing Firestore documents.\n- *skip*: documents with existing IDs will be skipped.\n⚠️ Please note that the *skip* resolution has really bad performance on large scale and can't use batch writes.", "default": "overwrite" }, "transformFunction": { "title": "Transform Function", "type": "string", "description": "Function that transforms each item from the dataset before importing it to Firestore. The function must return an object (or array of objects) with the `data` key that contains the transformed document and other optional fields. See README for more details and examples." }, "batchSize": { "title": "Batch Size", "type": "integer", "description": "Number of items to import in a single batch. Lower values are safer but slower, see [Firestore limits](https://firebase.google.com/docs/firestore/quotas) (10 MiB batch write). Please note that *skip* conflict resolution does not use batch writes and will always import one item at a time.", "default": 500 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }