可以传递给 initializeApp() 的可用选项。
签名:
export interface AppOptions
属性
属性 | 类型 | 说明 |
---|---|---|
凭据 | 凭据 | 一个 Credential 对象,用于对 Admin SDK 进行身份验证。如需查看详细文档和代码示例,请参阅初始化 SDK。 |
databaseAuthVariableOverride | 对象 | null | 当 Admin SDK 对 Realtime Database 执行读写操作时,要在 Realtime Database 规则中用作 auth 变量的对象。这样,您就可以缩小 Admin SDK 的默认完整读写权限。您可以传递 null 以充当未经身份验证的客户端。如需查看详细文档和代码示例,请参阅以有限权限进行身份验证。 |
database网址 | string | 需要从中读取和写入数据的 Realtime Database 的网址。 |
httpAgent | 代理 | 发出传出 HTTP 调用时使用的 HTTP 代理。所有进行 REST 调用的服务(例如 auth 、messaging 、projectManagement )均使用此代理实例。Realtime Database 和 Firestore 使用其他方式与后端服务器通信,因此不使用此 HTTP 代理。Credential 实例也不使用此 HTTP 代理,但支持在相应的工厂方法中指定 HTTP 代理。 |
projectId | string | 与应用关联的 Google Cloud 项目的 ID。 |
serviceAccountId | string | 用于对自定义令牌签名的服务账号的 ID。您可以在服务帐号 JSON 文件的 client_email 字段中找到此信息。 |
storageBucket | string | 用于存储应用数据的 Google Cloud Storage 存储分区的名称。请仅使用存储分区名称,不要添加任何前缀或添加内容(*切勿* 在名称前添加“gs://”)。 |
AppOptions.credential
用于对 Admin SDK 进行身份验证的 Credential 对象。
如需查看详细文档和代码示例,请参阅初始化 SDK。
签名:
credential?: Credential;
AppOptions.databaseAuthVariableOverride
当 Admin SDK 对 Realtime Database 执行读写操作时,要在 Realtime Database 规则中用作 auth 变量的对象。这样,您就可以缩小 Admin SDK 的默认完整读写权限。
您可以传递 null
以充当未经身份验证的客户端。
如需查看详细文档和代码示例,请参阅以有限权限进行身份验证。
签名:
databaseAuthVariableOverride?: object | null;
AppOptions.database网址
需要从中读取和写入数据的 Realtime Database 的网址。
签名:
databaseURL?: string;
AppOptions.httpAgent
发出传出 HTTP 调用时使用的 HTTP 代理。进行 REST 调用的所有服务(例如 auth
、messaging
、projectManagement
)均使用此代理实例。
Realtime Database 和 Firestore 使用其他方式与后端服务器通信,因此不使用此 HTTP 代理。Credential
实例也不使用此 HTTP 代理,但支持在相应的工厂方法中指定 HTTP 代理。
签名:
httpAgent?: Agent;
AppOptions.projectId
与应用关联的 Google Cloud 项目的 ID。
签名:
projectId?: string;
AppOptions.serviceAccountId
用于对自定义令牌签名的服务账号的 ID。您可以在服务帐号 JSON 文件的 client_email
字段中找到此信息。
签名:
serviceAccountId?: string;
AppOptions.storageBucket
用于存储应用数据的 Google Cloud Storage 存储分区的名称。请仅使用存储分区名称,不要添加任何前缀或添加内容(*切勿* 在名称前添加“gs://”)。
签名:
storageBucket?: string;