firebase-admin package

Firebase の名前空間方式 API（レガシー）

関数

関数 説明
app(name)
appCheck（アプリ） デフォルト アプリまたは特定のアプリの AppCheck サービスを取得します。引数なしで admin.appCheck() を呼び出してデフォルト アプリの AppCheck サービスにアクセスするか、admin.appCheck(app) として呼び出して、特定のアプリに関連付けられた AppCheck サービスにアクセスできます。
auth（アプリ） デフォルト アプリまたは特定のアプリの Auth サービスを取得します。引数なしで admin.auth() を呼び出してデフォルト アプリの Auth サービスにアクセスするか、admin.auth(app) として呼び出して特定のアプリに関連付けられた Auth サービスにアクセスできます。
database（アプリ） デフォルト アプリまたは特定のアプリの Database サービスを取得します。引数なしで admin.database() を呼び出してデフォルト アプリの Database サービスにアクセスするか、admin.database(app) として呼び出し、特定のアプリに関連付けられた Database サービスにアクセスできます。admin.database は、Database サービスに関連付けられたグローバル定数とメソッドへのアクセスに使用できる名前空間でもあります。
firestore（アプリ）
初期化アプリ(options, name)
インストール（アプリ） デフォルト アプリまたは特定のアプリの Installations サービスを取得します。admin.installations() を引数なしで呼び出してデフォルト アプリの Installations サービスにアクセスするか、admin.installations(app) として呼び出すと、特定のアプリに関連付けられている Installations サービスにアクセスできます。
instanceId（アプリ） デフォルト アプリまたは特定のアプリの InstanceId サービスを取得します。引数なしで admin.instanceId() を呼び出してデフォルト アプリの InstanceId サービスにアクセスするか、admin.instanceId(app) として呼び出して、特定のアプリに関連付けられている InstanceId サービスにアクセスできます。
machineLearning（アプリ） デフォルト アプリまたは特定のアプリの MachineLearning サービスを取得します。引数なしで admin.machineLearning() を呼び出してデフォルト アプリの MachineLearning サービスにアクセスするか、admin.machineLearning(app) として呼び出して、特定のアプリに関連付けられている MachineLearning サービスにアクセスできます。
messaging（アプリ） デフォルト アプリまたは特定のアプリの Messaging サービスを取得します。admin.messaging() は、引数なしで呼び出してデフォルト アプリの Messaging サービスにアクセスするか、admin.messaging(app) として呼び出し、特定のアプリに関連付けられた Messaging サービスにアクセスします。
projectManagement（アプリ） デフォルト アプリまたは特定のアプリの ProjectManagement サービスを取得します。引数なしで admin.projectManagement() を呼び出してデフォルト アプリの ProjectManagement サービスにアクセスするか、admin.projectManagement(app) として呼び出して、特定のアプリに関連付けられている ProjectManagement サービスにアクセスできます。
remoteConfig(アプリ) デフォルト アプリまたは特定のアプリの RemoteConfig サービスを取得します。引数なしで admin.remoteConfig() を呼び出してデフォルト アプリの RemoteConfig サービスにアクセスするか、admin.remoteConfig(app) として呼び出して、特定のアプリに関連付けられている RemoteConfig サービスにアクセスできます。
securityRules（アプリ） デフォルト アプリまたは特定のアプリの SecurityRules サービスを取得します。引数なしで admin.securityRules() を呼び出してデフォルト アプリの SecurityRules サービスにアクセスするか、admin.securityRules(app) として呼び出して特定のアプリに関連付けられた SecurityRules サービスにアクセスできます。
storage（アプリ） デフォルト アプリまたは特定のアプリの Storage サービスを取得します。引数なしで admin.storage() を呼び出してデフォルト アプリの Storage サービスにアクセスするか、admin.storage(app) として呼び出して、特定のアプリに関連付けられている Storage サービスにアクセスできます。

インターフェース

インターフェース 説明
AppOptions initialApp() に渡すことができるオプション。
FirebaseArrayIndexError エラーの発生したアイテムの取得に使用できる FirebaseError オブジェクトとインデックスの両方を含む複合型。
FirebaseError FirebaseError は、標準の JavaScript Error オブジェクトのサブクラスです。メッセージ文字列とスタック トレースに加えて、文字列コードも含まれます。
GoogleOAuthAccessToken Google OAuth 2.0 アクセス トークンのインターフェース。
サービス アカウント

名前空間

名前空間 説明
アプリ
appCheck
auth
クルデンシャル
データベース
firestore
インストール
instanceId
ML
メッセージ
プロジェクト管理
remoteConfig
セキュリティ ルール
ストレージ

変数

変数 説明
アプリ
SDK_VERSION

app(name)

署名:

export declare function app(name?: string): app.App;

パラメータ

パラメータ 型 説明
name 文字列

戻り値:

アプリ

appCheck（アプリ）

デフォルト アプリまたは指定されたアプリの AppCheck サービスを取得します。

デフォルト アプリの AppCheck サービスにアクセスするには、引数なしで admin.appCheck() を呼び出すか、admin.appCheck(app) として呼び出して特定のアプリに関連付けられている AppCheck サービスにアクセスします。

署名:

export declare function appCheck(app?: App): appCheck.AppCheck;

パラメータ

パラメータ 型 説明
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（アプリ）

デフォルト アプリまたは特定のアプリの Auth サービスを取得します。

admin.auth() を引数なしで呼び出すと、デフォルト アプリの Auth サービスにアクセスできます。また、admin.auth(app) として呼び出すと、特定のアプリに関連付けられた Auth サービスにアクセスできます。

署名:

export declare function auth(app?: App): auth.Auth;

パラメータ

パラメータ 型 説明
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 サービスを取得します。

デフォルト アプリの Database サービスにアクセスするには、引数なしで admin.database() を呼び出すか、admin.database(app) として呼び出して特定のアプリに関連付けられている Database サービスにアクセスします。

admin.database は、Database サービスに関連付けられたグローバル定数とメソッドへのアクセスに使用できる名前空間でもあります。

署名:

export declare function database(app?: App): database.Database;

パラメータ

パラメータ 型 説明
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;

パラメータ

パラメータ 型 説明
app アプリ

戻り値:

_firestore.Firestore

InitializeApp(options, name)

署名:

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;

パラメータ

パラメータ 型 説明
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 サービスを取得します。

デフォルト アプリの InstanceId サービスにアクセスするには、引数なしで admin.instanceId() を呼び出すか、admin.instanceId(app) として呼び出して特定のアプリに関連付けられている InstanceId サービスにアクセスします。

署名:

export declare function instanceId(app?: App): instanceId.InstanceId;

パラメータ

パラメータ 型 説明
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（アプリ）

デフォルト アプリまたは特定のアプリの Machine Learning サービスを取得します。

デフォルト アプリの MachineLearning サービスにアクセスするには、引数なしで admin.machineLearning() を呼び出すか、admin.machineLearning(app) として呼び出して特定のアプリに関連付けられている MachineLearning サービスにアクセスします。

署名:

export declare function machineLearning(app?: App): machineLearning.MachineLearning;

パラメータ

パラメータ 型 説明
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);

メッセージ（アプリ）

デフォルト アプリまたは指定されたアプリの Messaging サービスを取得します。

デフォルト アプリの Messaging サービスにアクセスするには、引数なしで admin.messaging() を呼び出すか、admin.messaging(app) として呼び出して特定のアプリに関連付けられている Messaging サービスにアクセスします。

署名:

export declare function messaging(app?: App): messaging.Messaging;

パラメータ

パラメータ 型 説明
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（アプリ）

デフォルト アプリまたは指定されたアプリの ProjectManagement サービスを取得します。

admin.projectManagement() を引数なしで呼び出してデフォルト アプリの ProjectManagement サービスにアクセスするか、admin.projectManagement(app) として呼び出して特定のアプリに関連付けられている ProjectManagement サービスにアクセスします。

署名:

export declare function projectManagement(app?: App): projectManagement.ProjectManagement;

パラメータ

パラメータ 型 説明
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（アプリ）

デフォルト アプリまたは指定されたアプリの RemoteConfig サービスを取得します。

デフォルト アプリの RemoteConfig サービスにアクセスするには、引数なしで admin.remoteConfig() を呼び出すか、admin.remoteConfig(app) として呼び出して特定のアプリに関連付けられている RemoteConfig サービスにアクセスします。

署名:

export declare function remoteConfig(app?: App): remoteConfig.RemoteConfig;

パラメータ

パラメータ 型 説明
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;

パラメータ

パラメータ 型 説明
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 サービスを取得します。

デフォルト アプリの Storage サービスにアクセスするには、引数なしで admin.storage() を呼び出すか、admin.storage(app) として呼び出して特定のアプリに関連付けられている Storage サービスにアクセスします。

署名:

export declare function storage(app?: App): storage.Storage;

パラメータ

パラメータ 型 説明
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