initialApp() に渡すことができるオプション。
署名:
export interface AppOptions
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| クルデンシャル | Credential | Admin SDK の認証に使用される Credential オブジェクト。詳細なドキュメントとコードサンプルについては、SDK を初期化するをご覧ください。 |
| databaseAuthVariableOverride | オブジェクト | null | Admin SDK が Realtime Database に対して読み取りまたは書き込みを行う際に、Realtime Database ルールで auth 変数として使用するオブジェクト。これにより、デフォルトの完全な読み取り / 書き込み権限から Admin SDK の範囲を限定できます。未認証クライアントとして動作するように null を渡すことができます。詳細なドキュメントとコードサンプルについては、制限付きの権限で認証するをご覧ください。 |
| databaseURL | 文字列 | データの読み取りと書き込みを行う Realtime Database の URL。 |
| http エージェント | エージェント | HTTP 呼び出しの送信時に使用する HTTP エージェント。このエージェント インスタンスは、REST 呼び出しを行うすべてのサービスで使用されます（例: auth、messaging、projectManagement）。Realtime Database と Firestore は、バックエンド サーバーとの通信に他の手段を使用しているため、この HTTP エージェントは使用されません。Credential インスタンスもこの HTTP エージェントを使用しませんが、代わりに対応するファクトリ メソッドで HTTP エージェントを指定できます。 |
| projectId | 文字列 | アプリに関連付けられた Google Cloud プロジェクトの ID。 |
| serviceAccountId | 文字列 | カスタム トークンの署名に使用されるサービス アカウントの ID。これは、サービス アカウント JSON ファイルの client_email フィールドにあります。 |
| storageBucket | 文字列 | アプリケーション データの保存に使用される Google Cloud Storage バケットの名前。接頭辞や追加を付けないバケット名のみを使用します（名前の前に「gs://」を付けないでください）。 |
AppOptions.credential
Admin SDK の認証に使用される Credential オブジェクト。
詳細なドキュメントとコードサンプルについては、SDK を初期化するをご覧ください。
署名:
credential?: Credential;
AppOptions.databaseAuthVariableOverride
Admin SDK が Realtime Database に対して読み取りまたは書き込みを行う際に、Realtime Database ルールで auth 変数として使用するオブジェクト。これにより、Admin SDK のデフォルトの読み取り / 書き込み権限の範囲を限定できます。
null を渡して、未認証のクライアントとして動作させることができます。
詳細なドキュメントとコードサンプルについては、制限付きの権限で認証するをご覧ください。
署名:
databaseAuthVariableOverride?: object | null;
AppOptions.databaseURL
データの読み取りと書き込みを行う Realtime Database の URL。
署名:
databaseURL?: string;
AppOptions.httpAgent
HTTP 呼び出しの送信時に使用する HTTP エージェント。このエージェント インスタンスは、REST 呼び出しを行うすべてのサービスで使用されます（例: auth、messaging、projectManagement）。
Realtime Database と Firestore はバックエンド サーバーとの通信に他の手段を使用するため、この HTTP エージェントは使用されません。Credential インスタンスもこの HTTP エージェントを使用しませんが、代わりに対応するファクトリ メソッドで HTTP エージェントを指定できます。
署名:
httpAgent?: Agent;
AppOptions.projectId
アプリに関連付けられた Google Cloud プロジェクトの ID。
署名:
projectId?: string;
AppOptions.serviceAccountId
カスタム トークンの署名に使用されるサービス アカウントの ID。これは、サービス アカウント JSON ファイルの client_email フィールドにあります。
署名:
serviceAccountId?: string;
AppOptions.storageBucket
アプリケーション データの保存に使用される Google Cloud Storage バケットの名前。接頭辞や追加を付けないバケット名のみを使用します（名前の前に「gs://」を付けないでください）。
署名:
storageBucket?: string;