Firebase 名前空間 API (レガシー)。
機能
関数 | 説明 |
---|---|
アプリ(名前) | |
appCheck(アプリ) | デフォルトのアプリまたは指定されたアプリのAppCheckサービスを取得します。 admin.appCheck() 引数なしで呼び出してデフォルトのアプリのAppCheck サービスにアクセスすることも、 admin.appCheck(app) として呼び出して特定のアプリに関連付けられたAppCheck サービスにアクセスすることもできます。 |
認証(アプリ) | デフォルトのアプリまたは指定されたアプリの認証サービスを取得します。 admin.auth() 引数なしで呼び出してデフォルトのアプリの認証サービスにアクセスすることも、 admin.auth(app) として呼び出して特定のアプリに関連付けられた認証サービスにアクセスすることもできます。 |
データベース(アプリ) | デフォルトのアプリまたは指定されたアプリのデータベースサービスを取得します。 admin.database() 引数なしで呼び出してデフォルトのアプリのDatabase サービスにアクセスすることも、 admin.database(app) として呼び出して特定のアプリに関連付けられたDatabase サービスにアクセスすることもできます。 admin.database 、 Database サービスに関連付けられたグローバル定数とメソッドにアクセスするために使用できる名前空間でもあります。 |
ファイアストア(アプリ) | |
InitializeApp(オプション, 名前) | |
インストール(アプリ) | デフォルトのアプリまたは指定されたアプリのインストールサービスを取得します。 admin.installations() 引数なしで呼び出してデフォルトのアプリのインストールサービスにアクセスすることも、 admin.installations(app) として呼び出して特定のアプリに関連付けられたインストールサービスにアクセスすることもできます。 |
インスタンスID(アプリ) | デフォルトのアプリまたは指定されたアプリのInstanceIdサービスを取得します。 admin.instanceId() 引数なしで呼び出してデフォルトのアプリのInstanceId サービスにアクセスすることも、 admin.instanceId(app) として呼び出して特定のアプリに関連付けられたInstanceId サービスにアクセスすることもできます。 |
機械学習(アプリ) | デフォルトのアプリまたは指定されたアプリのMachineLearningサービスを取得します。 admin.machineLearning() 引数なしで呼び出してデフォルト アプリのMachineLearning サービスにアクセスすることも、 admin.machineLearning(app) として呼び出して特定のアプリに関連付けられたMachineLearning サービスにアクセスすることもできます。 |
メッセージング(アプリ) | デフォルトのアプリまたは指定されたアプリのメッセージングサービスを取得します。 admin.messaging() 引数なしで呼び出してデフォルトのアプリのMessaging サービスにアクセスすることも、 admin.messaging(app) として呼び出して特定のアプリに関連付けられたMessaging サービスにアクセスすることもできます。 |
プロジェクト管理(アプリ) | デフォルトのアプリまたは指定されたアプリのProjectManagementサービスを取得します。 admin.projectManagement() 引数なしで呼び出してデフォルト アプリのProjectManagement サービスにアクセスすることも、 admin.projectManagement(app) として呼び出して特定のアプリに関連付けられたProjectManagement サービスにアクセスすることもできます。 |
リモート構成(アプリ) | デフォルトのアプリまたは指定されたアプリのRemoteConfigサービスを取得します。 admin.remoteConfig() 引数なしで呼び出してデフォルト アプリのRemoteConfig サービスにアクセスすることも、 admin.remoteConfig(app) として呼び出して特定のアプリに関連付けられたRemoteConfig サービスにアクセスすることもできます。 |
セキュリティルール(アプリ) | デフォルトのアプリまたは指定されたアプリのSecurityRulesサービスを取得します。 admin.securityRules() 引数なしで呼び出してデフォルト アプリのSecurityRulesサービスにアクセスすることも、 admin.securityRules(app) として呼び出して特定のアプリに関連付けられたSecurityRulesサービスにアクセスすることもできます。 |
ストレージ(アプリ) | デフォルトのアプリまたは指定されたアプリのストレージサービスを取得します。 admin.storage() 引数なしで呼び出してデフォルトのアプリのStorage サービスにアクセスすることも、 admin.storage(app) として呼び出して特定のアプリに関連付けられたStorage サービスにアクセスすることもできます。 |
インターフェース
インターフェース | 説明 |
---|---|
アプリオプション | InitializeApp()に渡すことができるオプション。 |
FirebaseArrayIndexError | FirebaseError オブジェクトと、エラーが発生した項目を取得するために使用できるインデックスの両方を含む複合タイプ。 |
FirebaseError | FirebaseError 、標準の JavaScript Error オブジェクトのサブクラスです。メッセージ文字列とスタック トレースに加えて、文字列コードが含まれています。 |
GoogleOAuthアクセストークン | Google OAuth 2.0 アクセス トークンのインターフェイス。 |
サービスアカウント |
名前空間
名前空間 | 説明 |
---|---|
アプリ | |
アプリチェック | |
認証 | |
資格情報 | |
データベース | |
消防署 | |
インスタレーション | |
インスタンスID | |
機械学習 | |
メッセージング | |
プロジェクト管理 | |
リモート構成 | |
セキュリティルール | |
ストレージ |
変数
変数 | 説明 |
---|---|
アプリ | |
SDK_VERSION |
アプリ()
サイン:
export declare function app(name?: string): app.App;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
名前 | 弦 |
戻り値:
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);
認証()
デフォルトのアプリまたは指定されたアプリの認証サービスを取得します。
admin.auth()
引数なしで呼び出してデフォルトのアプリの認証サービスにアクセスすることも、 admin.auth(app)
として呼び出して特定のアプリに関連付けられた認証サービスにアクセスすることもできます。
サイン:
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);
データベース()
デフォルトのアプリまたは指定されたアプリのデータベースサービスを取得します。
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);
ファイアストア()
サイン:
export declare function firestore(app?: App): _firestore.Firestore;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | アプリ |
戻り値:
_firestore.Firestore
初期化App()
サイン:
export declare function initializeApp(options?: AppOptions, name?: string): app.App;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
オプション | アプリオプション | |
名前 | 弦 |
戻り値:
インストール()
デフォルトのアプリまたは指定されたアプリのインストールサービスを取得します。
admin.installations()
引数なしで呼び出してデフォルトのアプリのインストールサービスにアクセスすることも、 admin.installations(app)
として呼び出して特定のアプリに関連付けられたインストールサービスにアクセスすることもできます。
サイン:
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);
インスタンスID()
デフォルトのアプリまたは指定されたアプリの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);
機械学習()
デフォルトのアプリまたは指定されたアプリのMachineLearningサービスを取得します。
admin.machineLearning()
引数なしで呼び出してデフォルト アプリのMachineLearning
サービスにアクセスすることも、 admin.machineLearning(app)
として呼び出して特定のアプリに関連付けられたMachineLearning
サービスにアクセスすることもできます。
サイン:
export declare function machineLearning(app?: App): 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);
メッセージング()
デフォルトのアプリまたは指定されたアプリのメッセージングサービスを取得します。
admin.messaging()
引数なしで呼び出してデフォルトのアプリのMessaging
サービスにアクセスすることも、 admin.messaging(app)
として呼び出して特定のアプリに関連付けられたMessaging
サービスにアクセスすることもできます。
サイン:
export declare function messaging(app?: App): 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サービスを取得します。
admin.projectManagement()
引数なしで呼び出してデフォルト アプリのProjectManagement
サービスにアクセスすることも、 admin.projectManagement(app)
として呼び出して特定のアプリに関連付けられたProjectManagement
サービスにアクセスすることもできます。
サイン:
export declare function projectManagement(app?: App): 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サービスを取得します。
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サービスを取得します。
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);
ストレージ()
デフォルトのアプリまたは指定されたアプリのストレージサービスを取得します。
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