安装 Firebase 扩展程序

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

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


若要安装或管理扩展程序,您必须拥有以下某个角色:Owner 或 EditorFirebase Admin

若要安装扩展程序,您的项目必须采用 Blaze(随用随付)方案。虽然安装扩展程序是免费的,但如果超出 Firebase 服务或 Cloud 服务(例如 [Cloud Secret Manager][secret-pricing])的免费层级,您可能会需要支付相应的费用。

准备工作

如果还没有将 Firebase 添加到您的项目,请先添加;然后将 Firebase 项目升级为 Blaze(随用随付)方案。

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

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

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

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

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

  1. 从以下来源浏览官方 Firebase 扩展程序:

  2. 点击扩展程序卡片即可:

第 2 步:安装扩展程序

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

  1. 从以下来源浏览官方 Firebase 扩展程序:

  2. 点击扩展程序的卡片,然后查看该扩展程序的详细信息,该信息可提供具体的使用说明和任何预安装任务。

  3. 点击安装,然后按照屏幕上的说明安装扩展程序。

第 3 步:完成安装后设置

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

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

创建 Firebase 资源

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

创建 Eventarc 事件处理脚本

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

请参阅该扩展程序的文档,了解它发布的事件的列表(如果有)。

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

安装多个扩展程序实例

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

后续步骤