Firestore

Firestore コネクタを使用すると、Firestore でサポートされているオペレーションを実行できます。

準備

Firestore コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワークパターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。
OAuth 2.0 認証の代わりにサービスアカウント認証を使用している場合は、サービスアカウントに適切な権限が付与されていることを確認してください。詳細については、IAM のロールと権限をご覧ください。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [次へ] をクリックします。

[接続の詳細] セクションで、次のフィールドを設定します。

コネクタ: 使用可能なコネクタのプルダウンリストから [Firestore] を選択します。
コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
[接続名] フィールドに、接続インスタンスの名前を入力します。
接続名は次の条件を満たす必要があります。
- 接続名には英字、数字、ハイフンを使用できます。
- 文字は小文字のみを使用できます。
- 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
- 接続名は 63 文字以内で指定してください。
必要に応じて、接続インスタンスの [説明] を入力します。
必要に応じて、コネクタ実行の詳細を記録する場合は、[Cloud Logging を有効にする] を選択します。
サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
[次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  次の認証タイプのいずれかを選択できます。
  - OAuth 2.0
  - サービスアカウント
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

OAuth 2.0
- クライアント ID: バックエンド Google サービスに接続するために必要なクライアント ID。
- スコープ: プルダウンから必要な OAuth 2.0 スコープを選択します。必要な Google サービスでサポートされている OAuth 2.0 スコープを確認するには、Google API の OAuth 2.0 スコープページの関連セクションをご覧ください。
- クライアントシークレット: クライアントシークレットに関連付けられたパスワードを含む Secret Manager のシークレットを選択します。
- シークレットのバージョン: シークレットのバージョンを選択します。
サービスアカウント
この接続を構成するときに前の手順で指定したサービスアカウントを使用して認証するには、このオプションを選択します。認証に必要な適切な IAM ロールと権限が付与されているサービスアカウントを指定していることを確認します。
- スコープ: プルダウンから必要な OAuth 2.0 スコープを選択します。詳細については、アクセススコープをご覧ください。

アクション

接続されたバックエンドサービスのオブジェクトを抽象化するレイヤを提供します。バックエンドのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化はアクションとして公開されます。Action は、コネクタインターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

統合で Firestore 接続を使用する

接続を作成すると、Application Integration で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。