安装 Firebase 扩展程序

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

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

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

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

准备工作

如果您尚未将 Firebase 添加到您的项目，请先添加。
如果尚未将项目升级到 Blaze（随用随付）方案，请先升级。
安装或更新到 Firebase CLI 的最新版本。
记下您的 Firebase 项目 ID 或之前配置的项目别名。
- 项目 ID - 从计算机上的任意位置运行 firebase projects:list。
- 项目别名 - 从本地应用目录运行 firebase use。
注意：如需使用 CLI 命令安装和管理扩展程序，您需要使用 --project 标志并传入项目 ID 或项目别名。但是，如果您已将 Firebase 项目与本地应用目录相关联，则从本地应用目录运行命令时无需传递 --project 标志。

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

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

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

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

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

请确保您已设置环境并选择了某个扩展程序。
从计算机上的任意位置运行 extension-info 命令：
```
firebase ext:info publisher-id/extension-id
```
publisher-id 和 extension-id 参数是必需的，可以在扩展程序的预安装详情页面上找到。

第 2 步：安装扩展程序

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

请确保您已设置环境并选择了某个扩展程序。
运行 extension-install 命令。如果出现提示，请输入参数值以自定义扩展程序实例。
```
firebase ext:install publisher-id/extension-id --project=projectId-or-alias
```
publisher-id 和 extension-id 参数是必需的，可以在扩展程序的预安装详情页面上找到。

注意：安装和预配扩展程序可能需要 3-5 分钟。
请在安装期间忽略交互式终端发出的输入参数值的提示
1. 创建一个用于定义参数值的 .env 文件（例如 params.env）。在本地保存该文件。
  - 根据扩展程序的 extension.yaml 文件中的 param 值声明每个参数。
  - 包含所有参数的值。
  - 遵循 dotenv 语法。
  例如，对于 Translate Text 扩展程序，您可以创建以下 .env 文件：
```
# params.env

LOCATION=us-east1
LANGUAGES=fr,es
COLLECTION_PATH=translations
INPUT_FIELD_NAME=input
OUTPUT_FIELD_NAME=output
```
2. 运行带有 --params 标志的 extension-install 命令。例如，若要安装 Translate Text 扩展程序，请运行以下命令：
```
firebase ext:install firebase/firestore-translate-text --params=path/to/params.env --project=projectID-or-alias
```
安装完成后，请查看扩展程序的使用说明，其中可能包括一些必须执行的安装后任务。
- 在 Firebase 控制台的 Extensions 信息中心的扩展程序安装后详情页面中可以找到这些说明（安装后，终端会显示指向信息中心的特定链接）。
  
  您还可以在扩展程序的源目录中包含的 POSTINSTALL.md 文件中找到这些说明。
- 如适用，这些说明将帮助您了解如何测试扩展程序（请查找查看实际应用效果部分）。

安装多个扩展程序实例

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

后续步骤

在 Firebase 控制台中查看已安装的扩展程序的详细信息和配置。
监控已安装的扩展程序的活动，包括检查其运行状况、使用情况和日志。
使用 Firebase CLI 管理已安装的扩展程序。您可以重新配置或卸载扩展程序，也可以将扩展程序更新到最新版本。
使用 Firebase 控制台管理已安装的扩展程序。对于官方 Firebase 扩展程序，您可以重新配置或卸载扩展程序，也可以将扩展程序更新到最新版本。
对于所有项目，最佳做法是确保在 Firebase 控制台中为您的项目设置预算提醒，并监控您的使用情况和结算信息中心。