安装 Firebase Extensions 扩展程序

您可以使用 Firebase 控制台或 Firebase CLI（命令行界面）安装（和管理）任何官方 Firebase Extensions 扩展程序。

请务必查看 Firebase CLI 和 Firebase 控制台支持的操作之间的差异。


如需安装或管理扩展程序，您必须拥有以下某个角色：Owner 或 Editor 或 Firebase Admin。

如需安装扩展程序，您的项目必须采用 Blaze（随用随付）方案。虽然扩展程序可以免费安装，但如果超出 Firebase 服务或 Cloud 服务（例如 Cloud Secret Manager）的免费层级，您可能就需要支付相应的费用。

准备工作

  1. 将 Firebase 添加到您的项目（如果尚未添加）。

  2. 将项目升级为 Blaze（随用随付）方案（如果尚未升级）。

  3. 安装或更新到 Firebase CLI 的最新版本。

  4. 记下您的 Firebase 项目 ID 或之前配置的项目别名。

    • 项目 ID - 从计算机上的任意位置运行 firebase projects:list。
    • 项目别名 - 从本地应用目录运行 firebase use。

第 1 步：查看扩展程序的相关详情

这是可选步骤，但我们强烈建议您执行此操作。

在安装 Firebase Extensions 扩展程序之前，我们建议您先查看该扩展程序的详细信息，包括：

  • 扩展程序的工作方式、任何预安装的任务以及扩展程序的相关详情
  • 一般标识信息和说明
  • 扩展程序的任务是否需要结算帐号
  • 执行操作所需的 Google 服务 (API) 和访问角色
  • 为扩展程序创建的资源（如函数）
  • 用户可配置参数的说明

如需查看扩展程序的详细信息，请执行以下操作：

  1. 确保您已设置环境并选择了某个扩展程序。

  2. 从计算机上的任意位置运行 extension-info 命令：

    firebase ext:info publisher-id/extension-id

    publisher-id 和 extension-id 参数是必需的，可以在扩展程序的预安装详情页面上找到。

第 2 步：安装扩展程序

在安装过程中，系统会提示您查看扩展程序的基本规范（例如启用的 API、创建的资源、授予的访问权限等）。系统会告知您所有结算要求，并提示您为扩展程序的可配置参数指定值。

  1. 请确保您已设置环境并选择了某个扩展程序。

  2. 在本地 Firebase 目录中，运行 extension-install 命令。 如果出现提示，请输入参数值以自定义扩展程序实例。

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    publisher-id 和 extension-id 参数是必需的，可以在扩展程序的预安装详情页面上找到。

    运行此命令会将扩展程序实例添加到您的扩展程序清单。

  3. 接下来，如需将清单中的扩展程序部署到 Firebase 项目，请运行以下命令： 

    firebase deploy --only extensions --project=projectId-or-alias

第 3 步：完成安装后设置

对于某些扩展程序，您需要完成必需或可选步骤，然后才能使用。在 Firebase 控制台上 Extensions 信息中心内扩展程序的安装后详情页面中可以找到这些说明（安装后，终端会显示指向信息中心的特定链接）。

您还可以在扩展程序的源目录中包含的 POSTINSTALL.md 文件内找到这些说明。

创建 Firebase 资源

如果您将扩展程序配置为使用尚不存在的 Firebase 资源（Cloud Firestore 集合、Realtime Database 路径、Cloud Storage 存储桶），请先创建这些资源，然后再使用该扩展程序。

创建 Eventarc 事件处理脚本

如果执行期间发生重要事件，某些扩展程序会向 Eventarc 发布事件。如果扩展程序发布了事件并且您在安装期间启用了事件，则您可以编写函数，使用自己的自定义逻辑对这些事件进行响应。这一功能非常有用。例如，在长时间运行的任务完成时通知用户，或对扩展程序函数的输出进行后处理。

请参阅该扩展程序的文档，了解它发布的事件的列表（如果有）。如需查看示例，请参阅“使用 Stripe 运行付款”扩展程序的事件类型。

然后，请参阅自定义事件触发器，了解如何编写 Eventarc 事件处理脚本。

安装多个扩展程序实例

注意：您可以在同一项目中多次安装同一扩展程序。 每个已安装的实例都可以拥有自己的自定义配置和扩展程序资源。您可以使用项目中不重复的实例 ID 标识和引用每个已安装的实例。系统会提示您确认或修改安装的每个额外扩展程序实例的 ID。

后续步骤