Installer une extension Firebase

Vous pouvez installer (et gérer) n'importe quelle extension Firebase officielle à l'aide de la console Firebase, de la CLI Firebase (interface de ligne de commande) ou d'un SDK généré automatiquement.

Veillez à examiner les différences entre les actions compatibles pour chaque méthode d'installation.



Pour installer ou gérer des extensions, vous devez disposer de l'un des rôles suivants : Propriétaire ou éditeur ou Administrateur Firebase.

Pour que vous puissiez installer une extension, votre projet doit disposer du forfait Blaze (paiement à l'usage). Bien que l'installation d'une extension ne soit pas facturée, vous pouvez être facturé pour votre utilisation des services Firebase ou des services Cloud tels que Cloud Secret Manager si votre utilisation dépasse le niveau sans frais des services.

Avant de commencer

Si ce n'est pas encore fait, ajoutez Firebase à votre projet et passez à la formule Blaze (paiement à l'usage).

Étape 1: Afficher des informations détaillées sur une extension

Cette étape est facultative, mais vivement recommandée.

Avant d'installer un Firebase Extension, nous vous recommandons de consulter des informations détaillées sur l'extension, y compris:

  • Fonctionnement de l'extension, tâches de préinstallation et informations sur l'extension
  • Informations générales permettant d'identifier l'application et description
  • Indique si les tâches de l'extension nécessitent un compte de facturation
  • Services Google (API) et rôles d'accès requis pour le fonctionnement
  • Ressources créées pour l'extension (comme les fonctions)
  • Description des paramètres configurables par l'utilisateur

Pour afficher les informations détaillées d'une extension:

  1. Parcourez les extensions Firebase officielles dans Extensions Hub.

  2. Cliquez sur la fiche d'une extension pour:

Étape 2: Installez une extension

Au cours du processus d'installation, vous êtes invité à examiner les spécifications de base de l'extension (telles que les API activées, les ressources créées, l'accès accordé, etc.). Vous serez informé de vos éventuelles exigences de facturation et vous serez également invité à spécifier des valeurs pour les paramètres configurables de l'extension.

  1. Parcourez les extensions Firebase officielles dans Extensions Hub.

  2. Cliquez sur la fiche d'une extension, puis consultez les informations détaillées la concernant, qui peuvent fournir des instructions d'utilisation spécifiques et les tâches de préinstallation.

  3. Cliquez sur Installer, puis suivez les instructions à l'écran pour installer l'extension.

Étape 3: Terminez la configuration après installation

Certaines extensions nécessitent des étapes obligatoires ou facultatives avant de pouvoir les utiliser. Vous trouverez ces instructions sur la page d'informations post-installation de votre extension dans le tableau de bord Extensions de la console Firebase (le lien spécifique vers le tableau de bord s'affiche dans le terminal après l'installation).

Vous pouvez également trouver ces instructions dans le fichier POSTINSTALL.md inclus dans le répertoire source de l'extension.

Créer des ressources Firebase

Si vous avez configuré l'extension pour qu'elle utilise des ressources Firebase (collections Cloud Firestore, chemins Realtime Database, buckets Cloud Storage) qui n'existent pas encore, créez-les avant d'utiliser l'extension.

Créer des gestionnaires d'événements Eventarc

Certaines extensions publient des événements dans Eventarc lorsque des événements importants se produisent pendant l'exécution. Si une extension publie des événements et que vous les avez activés lors de l'installation, vous pouvez écrire des fonctions qui réagissent à ces événements avec votre propre logique personnalisée. Cela peut être utile, par exemple, pour avertir les utilisateurs lorsque des tâches de longue durée sont terminées ou pour post-traiter la sortie d'une fonction d'extension.

Consultez la documentation de l'extension pour obtenir la liste des événements (le cas échéant) qu'elle publie. Par exemple, consultez les types d'événements pour l'extension Run Payments with Stripe (Exécuter des paiements avec Stripe).

Consultez ensuite Déclencheurs d'événements personnalisés pour en savoir plus sur l'écriture de gestionnaires d'événements Eventarc.

Installer plusieurs instances d'une extension

Vous pouvez installer la même extension plusieurs fois dans le même projet. Chaque instance installée peut avoir sa propre configuration personnalisée et ses propres ressources d'extension. Vous identifiez et faites référence à chaque instance installée à l'aide de son ID d'instance, qui est unique dans votre projet.

Vous êtes invité à confirmer ou à modifier l'ID de chaque instance supplémentaire de l'extension que vous installez.

Étapes suivantes