firebase-admin package

Firebase 名前空間 API (レガシー)。

機能

関数説明
アプリ(名前)
appCheck(アプリ)デフォルトのアプリまたは指定されたアプリのAppCheckサービスを取得します。 admin.appCheck()引数なしで呼び出してデフォルトのアプリのAppCheckサービスにアクセスすることも、 admin.appCheck(app)として呼び出して特定のアプリに関連付けられたAppCheckサービスにアクセスすることもできます。
認証(アプリ)デフォルトのアプリまたは指定されたアプリの認証サービスを取得します。 admin.auth()引数なしで呼び出してデフォルトのアプリの認証サービスにアクセスすることも、 admin.auth(app)として呼び出して特定のアプリに関連付けられた認証サービスにアクセスすることもできます。
データベース(アプリ)デフォルトのアプリまたは指定されたアプリのデータベースサービスを取得します。 admin.database()引数なしで呼び出してデフォルトのアプリのDatabaseサービスにアクセスすることも、 admin.database(app)として呼び出して特定のアプリに関連付けられたDatabaseサービスにアクセスすることもできます。 admin.databaseDatabaseサービスに関連付けられたグローバル定数とメソッドにアクセスするために使用できる名前空間でもあります。
ファイアストア(アプリ)
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

アプリが提供されていない場合はデフォルトの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.databaseDatabaseサービスに関連付けられたグローバル定数とメソッドにアクセスするために使用できる名前空間でもあります。

サイン:

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サービスが返されます。

戻り値:

インスタンス ID.インスタンス ID

アプリが提供されていない場合はデフォルトの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

アプリが提供されていない場合はデフォルトの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