Firebase の名前空間方式 API（レガシー）。
関数
| 関数 | 説明 |
|---|---|
| app(name) | |
| appCheck(app) | デフォルト アプリまたは特定のアプリの AppCheck サービスを取得します。デフォルト アプリの AppCheck サービスにアクセスする場合は、引数なしで admin.appCheck() を呼び出します。特定のアプリに関連付けられた AppCheck サービスにアクセスするには、admin.appCheck(app) として呼び出します。 |
| auth(app) | デフォルト アプリまたは特定のアプリの Auth サービスを取得します。デフォルト アプリの Auth サービスにアクセスする場合は、引数なしで admin.auth() を呼び出します。特定のアプリに関連付けられた Auth サービスにアクセスするには、admin.auth(app) として呼び出すことができます。 |
| database（app） | デフォルト アプリまたは特定のアプリの Database サービスを取得します。admin.database() は、引数なしでデフォルト アプリの Database サービスにアクセスするか、admin.database(app) として呼び出して、特定のアプリに関連付けられた Database サービスにアクセスできます。admin.database は、Database サービスに関連付けられたグローバル定数とメソッドにアクセスするために使用できる名前空間でもあります。 |
| firestore(app) | |
| InitializeApp(options, name) | |
| installations（アプリ） | デフォルト アプリまたは特定のアプリの Installations サービスを取得します。admin.installations() を引数なしで呼び出すことで、デフォルト アプリの Installations サービスにアクセスするか、admin.installations(app) として特定のアプリに関連付けられた Installations サービスにアクセスできます。 |
| instanceId(app) | デフォルト アプリまたは特定のアプリの InstanceId サービスを取得します。admin.instanceId() は、引数なしでデフォルト アプリの InstanceId サービスにアクセスするか、admin.instanceId(app) として呼び出して、特定のアプリに関連付けられた InstanceId サービスにアクセスできます。 |
| machineLearning（アプリ） | デフォルト アプリまたは特定のアプリの MachineLearning サービスを取得します。admin.machineLearning() は、引数なしでデフォルト アプリの MachineLearning サービスにアクセスするか、admin.machineLearning(app) として呼び出して、特定のアプリに関連付けられた MachineLearning サービスにアクセスできます。 |
| メッセージ（アプリ） | デフォルト アプリまたは特定のアプリの Messaging サービスを取得します。admin.messaging() を引数なしで呼び出すと、デフォルト アプリの Messaging サービスにアクセスするか、admin.messaging(app) として呼び出し、特定のアプリに関連付けられた Messaging サービスにアクセスできます。 |
| projectManagement(app) | デフォルト アプリまたは特定のアプリの ProjectManagement サービスを取得します。admin.projectManagement() は、引数なしでデフォルト アプリの ProjectManagement サービスにアクセスするか、admin.projectManagement(app) として呼び出して、特定のアプリに関連付けられた ProjectManagement サービスにアクセスできます。 |
| remoteConfig(app) | デフォルト アプリまたは特定のアプリ用の RemoteConfig サービスを取得します。デフォルト アプリの RemoteConfig サービスにアクセスする場合は、引数なしで admin.remoteConfig() を呼び出します。特定のアプリに関連付けられた RemoteConfig サービスにアクセスするには、admin.remoteConfig(app) として呼び出します。 |
| securityRules(app) | デフォルト アプリまたは特定のアプリの SecurityRules サービスを取得します。デフォルト アプリの SecurityRules サービスにアクセスする場合は、引数なしで admin.securityRules() を呼び出すか、特定のアプリに関連付けられた SecurityRules サービスにアクセスする admin.securityRules(app) として呼び出します。 |
| storage（アプリ） | デフォルト アプリまたは特定のアプリの Storage サービスを取得します。admin.storage() は、引数なしでデフォルト アプリの Storage サービスにアクセスするか、admin.storage(app) として呼び出して、特定のアプリに関連付けられた Storage サービスにアクセスできます。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| AppOptions | InitializeApp() に渡す使用可能なオプション。 |
| FirebaseArrayIndexError | FirebaseError オブジェクトと、エラーとなったアイテムの取得に使用できるインデックスの両方を含む複合型。 |
| FirebaseError | FirebaseError は、標準の JavaScript Error オブジェクトのサブクラスです。メッセージ文字列とスタック トレースに加えて、文字列コードが含まれています。 |
| GoogleOAuthAccessToken | Google OAuth 2.0 アクセス トークンのインターフェース。 |
| ServiceAccount |
名前空間
| 名前空間 | 説明 |
|---|---|
| アプリ | |
| appCheck | |
| 認証 | |
| クルデンシャル | |
| データベース | |
| firestore | |
| インストール | |
| instanceId | |
| 機械学習 | |
| メッセージ | |
| projectManagement | |
| remoteConfig | |
| securityRules | |
| ストレージ |
変数
| 変数 | 説明 |
|---|---|
| アプリ | |
| SDK_VERSION |
アプリ（名前）
署名:
export declare function app(name?: string): app.App;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| name | 文字列 |
戻り値:
appCheck（アプリ）
デフォルト アプリまたは特定のアプリの AppCheck サービスを取得します。
admin.appCheck() を引数なしで呼び出すと、デフォルト アプリの AppCheck サービスにアクセスできます。admin.appCheck(app) として呼び出すと、特定のアプリに関連付けられた AppCheck サービスにアクセスできるようになります。
署名:
export declare function appCheck(app?: App): appCheck.AppCheck;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | AppCheck サービスを返すオプションのアプリ。指定しない場合は、デフォルトの AppCheck サービスが返されます。 |
戻り値:
アプリが指定されていない場合は、デフォルトの AppCheck サービス、または指定されたアプリに関連付けられた AppCheck サービス。
例 1
// Get the `AppCheck` service for the default app
var defaultAppCheck = admin.appCheck();
例 2
// Get the `AppCheck` service for a given app
var otherAppCheck = admin.appCheck(otherApp);
auth（app）
デフォルト アプリまたは特定のアプリの Auth サービスを取得します。
admin.auth() は、引数なしで呼び出すことで、デフォルト アプリの Auth サービスにアクセスするか、admin.auth(app) として呼び出して、特定のアプリに関連付けられた Auth サービスにアクセスできます。
署名:
export declare function auth(app?: App): auth.Auth;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ |
戻り値:
例 1
// Get the Auth service for the default app
var defaultAuth = admin.auth();
例 2
// Get the Auth service for a given app
var otherAuth = admin.auth(otherApp);
データベース（アプリ）
デフォルト アプリまたは特定のアプリの Database サービスを取得します。
admin.database() を引数なしで呼び出すと、デフォルト アプリの Database サービスにアクセスできます。admin.database(app) として呼び出すと、特定のアプリに関連付けられた Database サービスにアクセスできるようになります。
admin.database は、Database サービスに関連付けられたグローバル定数とメソッドへのアクセスに使用できる名前空間でもあります。
署名:
export declare function database(app?: App): database.Database;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ |
戻り値:
アプリが指定されていない場合はデフォルトの Database サービス、または指定されたアプリに関連付けられた Database サービス。
例 1
// Get the Database service for the default app
var defaultDatabase = admin.database();
例 2
// Get the Database service for a specific app
var otherDatabase = admin.database(app);
Firestore（アプリ）
署名:
export declare function firestore(app?: App): _firestore.Firestore;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ |
戻り値:
_firestore.Firestore
初期化アプリ(オプション, 名前)
署名:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| オプション | AppOptions | |
| name | 文字列 |
戻り値:
インストール（アプリ）
デフォルト アプリまたは特定のアプリの Installations サービスを取得します。
admin.installations() を引数なしで呼び出すと、デフォルト アプリの Installations サービスにアクセスできます。admin.installations(app) として呼び出すと、特定のアプリに関連付けられた Installations サービスにアクセスできます。
署名:
export declare function installations(app?: App): installations.Installations;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | Installations サービスを返すオプションのアプリ。指定しない場合は、デフォルトの Installations サービスが返されます。 |
戻り値:
アプリが指定されていない場合はデフォルトの Installations サービス、または指定されたアプリに関連付けられた Installations サービス。
例 1
// Get the Installations service for the default app
var defaultInstallations = admin.installations();
例 2
// Get the Installations service for a given app
var otherInstallations = admin.installations(otherApp);
instanceId（アプリ）
デフォルト アプリまたは特定のアプリの InstanceId サービスを取得します。
admin.instanceId() を引数なしで呼び出すと、デフォルト アプリの InstanceId サービスにアクセスできます。admin.instanceId(app) として呼び出すと、特定のアプリに関連付けられた InstanceId サービスにアクセスできるようになります。
署名:
export declare function instanceId(app?: App): instanceId.InstanceId;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | InstanceId サービスを返すオプションのアプリ。指定しない場合は、デフォルトの InstanceId サービスが返されます。 |
戻り値:
アプリが指定されていない場合はデフォルトの InstanceId サービス、または指定されたアプリに関連付けられた InstanceId サービス。
例 1
// Get the Instance ID service for the default app
var defaultInstanceId = admin.instanceId();
例 2
// Get the Instance ID service for a given app
var otherInstanceId = admin.instanceId(otherApp);
ML（アプリ）
デフォルト アプリまたは特定のアプリの ML サービスを取得します。
admin.machineLearning() を引数なしで呼び出すと、デフォルト アプリの MachineLearning サービスにアクセスできます。admin.machineLearning(app) として呼び出すと、特定のアプリに関連付けられた MachineLearning サービスにアクセスできるようになります。
署名:
export declare function machineLearning(app?: App): machineLearning.MachineLearning;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | MachineLearning サービスを返すオプションのアプリ。指定しない場合は、デフォルトの MachineLearning サービスが返されます。 |
戻り値:
machineLearning.MachineLearning
アプリが指定されていない場合はデフォルトの MachineLearning サービス、または指定されたアプリに関連付けられた MachineLearning サービス。
例 1
// Get the MachineLearning service for the default app
var defaultMachineLearning = admin.machineLearning();
例 2
// Get the MachineLearning service for a given app
var otherMachineLearning = admin.machineLearning(otherApp);
メッセージ（アプリ）
デフォルト アプリまたは指定されたアプリの Messaging サービスを取得します。
admin.messaging() を引数なしで呼び出すと、デフォルト アプリの Messaging サービスにアクセスできます。admin.messaging(app) として呼び出すと、特定のアプリに関連付けられた Messaging サービスにアクセスできるようになります。
署名:
export declare function messaging(app?: App): messaging.Messaging;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | Messaging サービスを返すオプションのアプリ。指定しない場合は、デフォルトの Messaging サービスが返されます。 |
戻り値:
Messaging.Messaging を使用します。
アプリが指定されていない場合はデフォルトの Messaging サービス、または指定されたアプリに関連付けられた Messaging サービス。
例 1
// Get the Messaging service for the default app
var defaultMessaging = admin.messaging();
例 2
// Get the Messaging service for a given app
var otherMessaging = admin.messaging(otherApp);
projectManagement（アプリ）
デフォルト アプリまたは特定のアプリの ProjectManagement サービスを取得します。
admin.projectManagement() を引数なしで呼び出すと、デフォルト アプリの ProjectManagement サービスにアクセスできます。admin.projectManagement(app) として呼び出すと、特定のアプリに関連付けられた ProjectManagement サービスにアクセスできるようになります。
署名:
export declare function projectManagement(app?: App): projectManagement.ProjectManagement;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | ProjectManagement サービスを返すオプションのアプリ。指定しない場合は、デフォルトの ProjectManagement サービスが返されます。* |
戻り値:
projectManagement.ProjectManagement
アプリが指定されていない場合はデフォルトの ProjectManagement サービス、または指定されたアプリに関連付けられた ProjectManagement サービス。
例 1
// Get the ProjectManagement service for the default app
var defaultProjectManagement = admin.projectManagement();
例 2
// Get the ProjectManagement service for a given app
var otherProjectManagement = admin.projectManagement(otherApp);
RemoteConfig（アプリ）
デフォルト アプリまたは特定のアプリの RemoteConfig サービスを取得します。
admin.remoteConfig() を引数なしで呼び出すと、デフォルト アプリの RemoteConfig サービスにアクセスできます。admin.remoteConfig(app) として呼び出すと、特定のアプリに関連付けられた RemoteConfig サービスにアクセスできるようになります。
署名:
export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | RemoteConfig サービスを返すオプションのアプリ。指定しない場合は、デフォルトの RemoteConfig サービスが返されます。 |
戻り値:
アプリが指定されていない場合は、デフォルトの RemoteConfig サービス、または指定されたアプリに関連付けられた RemoteConfig サービス。
例 1
// Get the `RemoteConfig` service for the default app
var defaultRemoteConfig = admin.remoteConfig();
例 2
// Get the `RemoteConfig` service for a given app
var otherRemoteConfig = admin.remoteConfig(otherApp);
securityRules（アプリ）
デフォルト アプリまたは特定のアプリの SecurityRules サービスを取得します。
admin.securityRules() を引数なしで呼び出すと、デフォルト アプリの SecurityRules サービスにアクセスできます。admin.securityRules(app) として呼び出すと、特定のアプリに関連付けられた SecurityRules サービスにアクセスできるようになります。
署名:
export declare function securityRules(app?: App): securityRules.SecurityRules;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ | SecurityRules サービスを返すオプションのアプリ。指定しない場合は、デフォルトの SecurityRules サービスが返されます。 |
戻り値:
アプリが指定されていない場合は、デフォルトの SecurityRules サービス、または指定されたアプリに関連付けられた SecurityRules サービス。
例 1
// Get the SecurityRules service for the default app
var defaultSecurityRules = admin.securityRules();
例 2
// Get the SecurityRules service for a given app
var otherSecurityRules = admin.securityRules(otherApp);
storage（アプリ）
デフォルト アプリまたは特定のアプリの Storage サービスを取得します。
admin.storage() を引数なしで呼び出すと、デフォルト アプリの Storage サービスにアクセスできます。admin.storage(app) として呼び出すと、特定のアプリに関連付けられた Storage サービスにアクセスできるようになります。
署名:
export declare function storage(app?: App): storage.Storage;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | アプリ |
戻り値:
例 1
// Get the Storage service for the default app
var defaultStorage = admin.storage();
例 2
// Get the Storage service for a given app
var otherStorage = admin.storage(otherApp);
アプリ
署名:
apps: (app.App | null)[]
SDK_VERSION
署名:
SDK_VERSION: string