Firebase Extensions

The Translate Text in Firestore extension automatically translates strings written to a specified Cloud Firestore collection into multiple target languages. It uses either the Cloud Translation API or Gemini (via Google AI or Vertex AI) to perform the translations.

Key Behaviors:

• Automatic Detection: The source language of the string is automatically detected.
• Automatic Updates: If the original non-translated field is updated, the translations are automatically updated.
• Output: Translations are written to a separate specified field within the same document.
• Multi-collection support: To translate multiple collections, install the extension multiple times with different collection paths.
• Multi-field support: To translate multiple fields in a single document, store a map of input strings in the designated input field.

// Example of translating multiple fields by storing a map in the input field
admin.firestore().collection('translations').add({
  first: "My name is Bob",
  second: "Hello, friend"
})

The Resize Images extension automatically detects image uploads to a specified Cloud Storage bucket and creates resized versions based on your dimensions. It supports JPEG, PNG, WebP, GIF, AVIF, and TIFF formats.

Key Features:

• Aspect Ratio Preservation: The extension maintains the original aspect ratio, shrinking the image until it fits within your specified maximum width and height.
• Metadata Copying: Automatically copies Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and user-provided metadata (including download tokens) to the resized images.
• Multiple Sizes: You can configure multiple output dimensions (e.g., 200x200, 400x400) for a single upload.
• Event Notifications: Can publish resize completion events via Eventarc, allowing you to trigger custom logic (like Cloud Functions) upon successful resizing.
• Content Filtering: Uses Google AI models (via Genkit) to detect and block inappropriate content based on configurable strictness levels or custom yes/no prompts.

The Delete User Data extension automatically removes data keyed on a user ID from Cloud Firestore, Realtime Database, or Cloud Storage when a user is deleted from Firebase Authentication. This helps in managing user privacy and fulfilling compliance requirements by ensuring that user-specific data is cleaned up following account deletion.

Prerequisites

• Your Firebase project must be on the Blaze (pay as you go) plan.
• You must have Firebase Authentication set up to manage users.
• Depending on your configuration, you must have Cloud Firestore, Realtime Database, or Cloud Storage initialized in your project.

Core Functionality

• Trigger: The extension is triggered by the deletion of a user from Firebase Authentication.
• Scope: It can delete data from Firestore, Realtime Database, and/or Cloud Storage based on your configuration.
• Identification: Data discovery is primarily keyed to the user's UID.

The Stream Firestore to BigQuery extension sends real-time, incremental updates from a specified Cloud Firestore collection to BigQuery. It creates a BigQuery dataset containing:

1. A raw data table: Stores a full change history of documents. Key metadata fields include timestamp, document_name, and the operation (e.g., CREATE, UPDATE, IMPORT, DELETE).
2. A view: Represents the current state of the data in your collection, showing the latest operation for each document.

Key Behaviors:

• Real-time & Incremental: Data in BigQuery mirrors your Firestore content as changes occur.
• Scope: It only listens to changes in the specified collection, not its subcollections. To monitor subcollections, use {wildcard} notation in the collection path (e.g., chats/{chatid}/posts).
• Wildcards: Enabling wildcard references adds a STRING column containing a JSON object of the wildcard IDs, which can be extracted using JSON_EXTRACT_SCALAR in BigQuery.

The Shorten URLs in Firestore extension automatically generates shortened Bitly URLs when a long URL is written to a specific field in a Cloud Firestore document. It listens to a specified collection and updates the document with the shortened version in a new field. If the original URL is updated, the extension automatically updates the shortened URL as well.

Prerequisites

• A Firebase project on the Blaze (pay as you go) plan.
• A configured Cloud Firestore database.
• A Bitly account and a generated Bitly access token (obtainable via Bitly OAuth Apps).

Configuration Parameters

When installing the extension, you must provide the following configuration:

IAM Permissions

The extension requires the following IAM role to function:

• datastore.user: Required to write the shortened URLs back to Cloud Firestore.