您可以使用 Firebase 控制台或Firebase CLI (命令行界面)安装(和管理)任何官方 Firebase 扩展。
请务必查看 Firebase CLI 和 Firebase 控制台支持的操作的差异。
要安装或管理扩展程序,您必须被分配以下角色之一: Owner 或 Editor或Firebase Admin 。
要安装扩展,您的项目必须采用Blaze (现收现付)计划。虽然安装扩展程序是免费的,但如果您的使用量超过服务的免费套餐,您可能会因使用 Firebase 服务或Cloud Secret Manager等云服务而付费。
在你开始之前
如果您还没有,请将 Firebase 添加到您的项目中。
如果您还没有,请将您的项目升级到Blaze (现收现付)计划。
记下您的 Firebase 项目 ID 或之前配置的项目别名。
第一步:查看扩展的详细信息
此步骤是可选的,但强烈推荐。
在安装 Firebase 扩展程序之前,我们建议您查看有关该扩展程序的详细信息,包括:
查看分机的详细信息:
从计算机上的任何位置运行 extension-info 命令:
firebase ext:info publisher-id/extension-id
publisher-id
和extension-id
参数是必需的,可以在扩展的预安装详细信息页面上找到。
第 2 步:安装扩展
在安装过程中,系统会提示您查看扩展的基本规范(例如启用的 API、创建的资源、授予的访问权限等)。您将收到任何计费要求的通知,并且还会提示您为扩展程序的可配置参数指定值。
在您的本地 Firebase 目录中,运行扩展安装命令。如果出现提示,请输入参数值以自定义扩展实例。
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
publisher-id
和extension-id
参数是必需的,可以在扩展的预安装详细信息页面上找到。运行此命令会将一个扩展实例添加到您的扩展清单中。
然后,要将清单中的扩展部署到 Firebase 项目,请运行:
firebase deploy --only extensions --project=projectId-or-alias
第 3 步:完成安装后设置
某些扩展程序具有必需或可选的步骤供您在使用前完成。在 Firebase 控制台的扩展仪表板的扩展安装后详细信息页面中找到这些说明(仪表板的特定链接在安装后显示在终端中)。
您还可以在扩展源目录中包含的POSTINSTALL.md
文件中找到这些说明。
创建 Firebase 资源
如果您将扩展程序配置为使用尚不存在的 Firebase 资源(Cloud Firestore 集合、实时数据库路径、Cloud Storage 存储桶),请在使用扩展程序之前创建它们。
创建 Eventarc 事件处理程序
当执行期间发生重要事件时,一些扩展会发布到Eventarc 。如果扩展发布事件并且您在安装期间启用了事件,则您可以编写使用您自己的自定义逻辑对这些事件做出反应的函数。这可能很有用,例如,在长时间运行的任务完成时通知用户,或对扩展函数的输出进行后处理。
有关它发布的事件列表(如果有),请参阅扩展的文档。
然后,请参阅自定义事件触发器以获取有关编写 Eventarc 事件处理程序的信息。
安装多个扩展实例
您可以在同一个项目中多次安装同一个扩展。每个已安装的实例都可以有自己的自定义配置和扩展资源。您使用实例 ID标识和引用每个已安装的实例,该实例在您的项目中是唯一的。系统将提示您确认或编辑您安装的每个附加扩展实例的实例 ID。
下一步
在 Firebase 控制台中查看已安装扩展程序的详细信息和配置。
监控已安装扩展的活动,包括检查其运行状况、使用情况和日志。
使用 Firebase CLI,管理您安装的扩展程序。您可以重新配置或卸载您的扩展,以及将您的扩展更新到最新版本。
使用 Firebase 控制台管理您安装的扩展程序。对于官方 Firebase 扩展,您可以重新配置或卸载您的扩展,以及将您的扩展更新到最新版本。
作为所有项目的最佳实践,请确保为您的项目设置预算提醒并在 Firebase 控制台中监控您的使用情况和计费信息中心。
您可以使用 Firebase 控制台或Firebase CLI (命令行界面)安装(和管理)任何官方 Firebase 扩展。
请务必查看 Firebase CLI 和 Firebase 控制台支持的操作的差异。
要安装或管理扩展程序,您必须被分配以下角色之一: Owner 或 Editor或Firebase Admin 。
要安装扩展,您的项目必须采用Blaze (现收现付)计划。虽然安装扩展程序是免费的,但如果您的使用量超过服务的免费套餐,您可能会因使用 Firebase 服务或Cloud Secret Manager等云服务而付费。
在你开始之前
如果您还没有,请将 Firebase 添加到您的项目中。
如果您还没有,请将您的项目升级到Blaze (现收现付)计划。
记下您的 Firebase 项目 ID 或之前配置的项目别名。
第一步:查看扩展的详细信息
此步骤是可选的,但强烈推荐。
在安装 Firebase 扩展程序之前,我们建议您查看有关该扩展程序的详细信息,包括:
查看分机的详细信息:
从计算机上的任何位置运行 extension-info 命令:
firebase ext:info publisher-id/extension-id
publisher-id
和extension-id
参数是必需的,可以在扩展的预安装详细信息页面上找到。
第 2 步:安装扩展
在安装过程中,系统会提示您查看扩展的基本规范(例如启用的 API、创建的资源、授予的访问权限等)。您将收到任何计费要求的通知,并且还会提示您为扩展程序的可配置参数指定值。
在您的本地 Firebase 目录中,运行扩展安装命令。如果出现提示,请输入参数值以自定义扩展实例。
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
publisher-id
和extension-id
参数是必需的,可以在扩展的预安装详细信息页面上找到。运行此命令会将一个扩展实例添加到您的扩展清单中。
然后,要将清单中的扩展部署到 Firebase 项目,请运行:
firebase deploy --only extensions --project=projectId-or-alias
第 3 步:完成安装后设置
某些扩展程序具有必需或可选的步骤供您在使用前完成。在 Firebase 控制台的扩展仪表板的扩展安装后详细信息页面中找到这些说明(仪表板的特定链接在安装后显示在终端中)。
您还可以在扩展源目录中包含的POSTINSTALL.md
文件中找到这些说明。
创建 Firebase 资源
如果您将扩展程序配置为使用尚不存在的 Firebase 资源(Cloud Firestore 集合、实时数据库路径、Cloud Storage 存储桶),请在使用扩展程序之前创建它们。
创建 Eventarc 事件处理程序
当执行期间发生重要事件时,一些扩展会发布到Eventarc 。如果扩展发布事件并且您在安装期间启用了事件,则您可以编写使用您自己的自定义逻辑对这些事件做出反应的函数。这可能很有用,例如,在长时间运行的任务完成时通知用户,或对扩展函数的输出进行后处理。
有关它发布的事件列表(如果有),请参阅扩展的文档。
然后,请参阅自定义事件触发器以获取有关编写 Eventarc 事件处理程序的信息。
安装多个扩展实例
您可以在同一个项目中多次安装同一个扩展。每个已安装的实例都可以有自己的自定义配置和扩展资源。您使用实例 ID标识和引用每个已安装的实例,该实例在您的项目中是唯一的。系统将提示您确认或编辑您安装的每个附加扩展实例的实例 ID。
下一步
在 Firebase 控制台中查看已安装扩展程序的详细信息和配置。
监控已安装扩展的活动,包括检查其运行状况、使用情况和日志。
使用 Firebase CLI,管理您安装的扩展程序。您可以重新配置或卸载您的扩展,以及将您的扩展更新到最新版本。
使用 Firebase 控制台管理您安装的扩展程序。对于官方 Firebase 扩展,您可以重新配置或卸载您的扩展,以及将您的扩展更新到最新版本。
作为所有项目的最佳实践,请确保为您的项目设置预算提醒并在 Firebase 控制台中监控您的使用情况和计费信息中心。