firebase-admin.app package

Firebase アプリと SDK の初期化。

関数

関数 説明
applicationDefault(httpAgent) Google アプリケーションのデフォルト認証情報から作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。Google アプリケーションのデフォルト認証情報は、Google App Engine や Google Compute Engine などのあらゆる Google インフラストラクチャで使用できます。詳しくは、SDK を初期化するをご覧ください。
cert(serviceAccountPathOrObject, httpAgent) 指定されたサービス アカウントから作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。詳細については、SDK を初期化するをご覧ください。
deleteApp(app) これは指定された App を使用不能にし、関連するすべてのサービスのリソースを解放します（ただし、バックエンド リソースはクリーンアップされません）。SDK をローカルで実行する場合は、プロセスを正常に終了するために、このメソッドを呼び出す必要があります。
getApp(アプリ名)
getApps()
InitializeApp(options, appName)
refreshToken(refreshTokenPathOrObject, httpAgent) 提供された更新トークンから作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。詳細については、SDK を初期化するをご覧ください。

クラス

クラス 説明
AppErrorCodes アプリ クライアントのエラーコードとそのデフォルト メッセージ。
FirebaseAppError Firebase アプリのエラーコードの構造。これは PrefixedFirebaseError を拡張します。

インターフェース

インターフェース 説明
App Firebase アプリは、サービスのコレクションの初期化情報を保持します。
AppOptions InitializeApp() に渡す使用可能なオプション。
Credential Firebase サービスでの認証に使用される Google OAuth2 アクセス トークンを提供するインターフェース。ほとんどの場合、これを自分で実装する必要はなく、代わりに firebase-admin/app モジュールが提供するデフォルトの実装を使用できます。
FirebaseArrayIndexError FirebaseError オブジェクトと、エラーとなったアイテムの取得に使用できるインデックスの両方を含む複合型。
FirebaseError FirebaseError は、標準の JavaScript Error オブジェクトのサブクラスです。メッセージ文字列とスタック トレースに加えて、文字列コードが含まれています。
GoogleOAuthAccessToken Google OAuth 2.0 アクセス トークンのインターフェース。
ServiceAccount

変数

変数 説明
SDK_VERSION

applicationDefault（httpAgent）

Google アプリケーションのデフォルト認証情報から作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。

Google アプリケーションのデフォルト認証情報は、Google App Engine や Google Compute Engine などのあらゆる Google インフラストラクチャで使用できます。

詳しくは、SDK を初期化するをご覧ください。

署名:

export declare function applicationDefault(httpAgent?: Agent): Credential;

パラメータ

パラメータ 型 説明
http エージェント エージェント オプションの HTTP エージェント。Google トークン サーバーからアクセス トークンを取得する際に使用されます。

戻り値:

Credential

Google アプリケーションのデフォルト認証情報によって認証される認証情報。アプリの初期化に使用できます。

例

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

cert（serviceAccountPathOrObject, httpAgent）

指定されたサービス アカウントから作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。

詳しくは、SDK を初期化するをご覧ください。

署名:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

パラメータ

パラメータ 型 説明
serviceAccountPathOrObject 文字列 |ServiceAccount サービス アカウント キーの JSON ファイル、またはサービス アカウント キーを表すオブジェクトのパス。
http エージェント エージェント オプションの HTTP エージェント。Google トークン サーバーからアクセス トークンを取得する際に使用されます。

戻り値:

Credential

提供されたサービス アカウントで認証される認証情報。アプリの初期化に使用できます。

例 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

例 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

deleteApp(app)

これは指定された App を使用不能にし、関連するすべてのサービスのリソースを解放します（ただし、バックエンド リソースはクリーンアップされません）。SDK をローカルで実行する場合は、プロセスを正常に終了するために、このメソッドを呼び出す必要があります。

署名:

export declare function deleteApp(app: App): Promise<void>;

パラメータ

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

戻り値:

約束 <void>

例

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

getApp（アプリ名）

署名:

export declare function getApp(appName?: string): App;

パラメータ

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

戻り値:

App

getApps()

署名:

export declare function getApps(): App[];

戻り値:

アプリ[]

初期化 App(options, appName)

署名:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

パラメータ

パラメータ 型 説明
オプション AppOptions
appName 文字列

戻り値:

App

refreshToken(refreshTokenPathOrObject, httpAgent)

提供された更新トークンから作成された認証情報を返します。認証情報は Firebase サービスへの管理者権限を付与します。この認証情報は、InitializeApp() の呼び出しで使用できます。

詳しくは、SDK を初期化するをご覧ください。

署名:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

パラメータ

パラメータ 型 説明
refreshTokenPathOrObject 文字列 |オブジェクト Google OAuth2 更新トークンの JSON ファイル、または Google OAuth2 更新トークンを表すオブジェクトへのパス。
http エージェント エージェント オプションの HTTP エージェント。Google トークン サーバーからアクセス トークンを取得する際に使用されます。

戻り値:

Credential

提供されたサービス アカウントで認証される認証情報。アプリの初期化に使用できます。

例

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

署名:

SDK_VERSION: string