googleFirebaseCloudFirestore.json•6.23 kB
{
"nodeType": "n8n-nodes-base.googleFirebaseCloudFirestore",
"displayName": "Google Cloud Firestore",
"description": "Interact with Google Firebase - Cloud Firestore API",
"version": [
1,
1.1
],
"properties": [
{
"name": "projectId",
"displayName": "Project Name or ID",
"type": "options",
"default": "",
"description": "As displayed in firebase console URL. Choose from the list, or specify an ID using an <a href=\"https://docs.n8n.io/code/expressions/\">expression</a>.",
"required": true,
"displayOptions": {
"show": {
"resource": [
"collection"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "database",
"displayName": "Database",
"type": "string",
"default": "(default)",
"description": "Usually the provided default value will work",
"required": true,
"displayOptions": {
"show": {
"resource": [
"collection"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "returnAll",
"displayName": "Return All",
"type": "boolean",
"default": false,
"description": "Whether to return all results or only up to a given limit",
"required": true,
"displayOptions": {
"show": {
"resource": [
"collection"
],
"operation": [
"getAll"
]
}
}
},
{
"name": "limit",
"displayName": "Limit",
"type": "number",
"default": 100,
"description": "Max number of results to return",
"typeOptions": {
"minValue": 1,
"maxValue": 500
},
"displayOptions": {
"show": {
"resource": [
"collection"
],
"operation": [
"getAll"
],
"returnAll": [
false
]
}
}
},
{
"name": "operation",
"displayName": "Operation",
"type": "options",
"default": "getAll",
"description": "Get many root collections",
"options": [
{
"name": "Get Many",
"value": "getAll",
"description": "Get many root collections"
}
],
"displayOptions": {
"show": {
"resource": [
"collection"
]
}
}
},
{
"name": "collection",
"displayName": "Collection",
"type": "string",
"default": "",
"description": "Collection name",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
]
}
}
},
{
"name": "documentId",
"displayName": "Document ID",
"type": "string",
"default": "",
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
]
}
}
},
{
"name": "columns",
"displayName": "Columns / Attributes",
"type": "string",
"default": "",
"description": "List of attributes to save",
"placeholder": "productId, modelName, description",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"create"
]
}
}
},
{
"name": "simple",
"displayName": "Simplify",
"type": "boolean",
"default": true,
"description": "Whether to return a simplified version of the response instead of the raw data",
"displayOptions": {
"show": {
"operation": [
"create"
],
"resource": [
"document"
]
}
}
},
{
"name": "updateKey",
"displayName": "Update Key",
"type": "string",
"default": "",
"description": "Must correspond to a document ID",
"placeholder": "documentId",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"upsert"
]
}
}
},
{
"name": "query",
"displayName": "Query JSON",
"type": "string",
"default": "",
"description": "JSON query to execute",
"placeholder": "{\"structuredQuery\": {\"where\": {\"fieldFilter\": {\"field\": {\"fieldPath\": \"age\"},\"op\": \"EQUAL\", \"value\": {\"integerValue\": 28}}}, \"from\": [{\"collectionId\": \"users-collection\"}]}}",
"required": true,
"displayOptions": {
"show": {
"resource": [
"document"
],
"operation": [
"query"
]
}
}
},
{
"name": "authentication",
"displayName": "Authentication",
"type": "options",
"default": "googleFirebaseCloudFirestoreOAuth2Api",
"options": [
{
"name": "OAuth2 (recommended)",
"value": "googleFirebaseCloudFirestoreOAuth2Api"
},
{
"name": "Service Account",
"value": "serviceAccount"
}
]
},
{
"name": "resource",
"displayName": "Resource",
"type": "options",
"default": "document",
"options": [
{
"name": "Document",
"value": "document"
},
{
"name": "Collection",
"value": "collection"
}
]
}
],
"credentialsConfig": [
{
"name": "googleFirebaseCloudFirestoreOAuth2Api",
"required": true
},
{
"name": "authentication",
"required": false
},
{
"name": "resource",
"required": false
}
],
"io": {
"inputs": [],
"outputs": [],
"outputNames": [],
"hints": {}
},
"wiring": {
"role": "generic",
"requires": [],
"optional": [],
"consumedBy": [],
"consumes": [],
"produces": []
}
}