InitializeApp() に渡す使用可能なオプション。
署名:
export interface AppOptions
プロパティ
プロパティ | 型 | 説明 |
---|---|---|
クルデンシャル | Credential | Admin SDK の認証に使用される Credential オブジェクト。詳細なドキュメントとコードサンプルについては、SDK の初期化をご覧ください。 |
databaseAuthVariableOverride | オブジェクト |null | Admin SDK が Realtime Database に対して読み取りまたは書き込みを行うときに、Realtime Database ルールで auth 変数として使用するオブジェクト。これにより、Admin SDK のデフォルトの完全な読み取り / 書き込み権限の範囲を絞り込むことができます。null を渡して、未認証のクライアントとして機能します。詳細なドキュメントとコードサンプルについては、制限付きの権限で認証するをご覧ください。 |
databaseURL | 文字列 | データの読み取りと書き込みを行う Realtime Database の URL。 |
httpAgent | エージェント | 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(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;