Firestore - Document Get タスクを使用すると、単一の Firestore ドキュメントのコンテンツを取得できます。デフォルトでは、Firestore - Document Get タスクは Firestore データベースから最新のドキュメント スナップショットを取得します。
Firestore は、自動スケーリングと高性能を実現し、アプリケーション開発を簡素化するように構築された NoSQL ドキュメント データベースです。
始める前に
Firestore - Document Get タスクを構成する前に、Google Cloud プロジェクトで次のタスクを実行します。
- Cloud Firestore API（
firestore.googleapis.com）を有効にします。 -
認証プロファイルを作成します。Apigee Integration では、認証プロファイルを使用して、Firestore - Document Get タスクの認証エンドポイントに接続します。
サービス アカウントへの追加のロールや権限の付与については、アクセス権の付与、変更、取り消しをご覧ください。
Firestore - Document Get タスクを構成する
- Apigee UI で、Apigee 組織を選択します。
- [Develop] > [Integrations] の順にクリックします。
- 既存のインテグレーションを選択するか、[Create Integration] をクリックして新しいインテグレーションを作成します。
新しいインテグレーションを作成する場合:
- [Create Integration] ダイアログで名前と説明を入力します。
- サポートされているリージョンのリストから、インテグレーションのリージョンを選択します。
- [Create] をクリックします。
インテグレーション デザイナーでインテグレーションが開きます。
- 統合デザイナーのナビゲーション バーで、[+Add a task/trigger] > [Tasks] の順にクリックして、使用可能なタスクのリストを表示します。
- 統合デザイナーで、[Firestore - Document Get] 要素をクリックして配置します。
- デザイナーで [Firestore - Document Get] 要素をクリックして、[Firestore - Document Get] タスク構成ペインを表示します。
- [認証] に移動し、使用する既存の認証プロファイルを選択します。
省略可。タスクを構成する前に認証プロファイルを作成していない場合は、[+ New authentication profile] をクリックし、新しい認証プロファイルを作成するに記載されている手順に沿って操作します。
- [Task Input] に移動し、次の「タスクの入力パラメータ」の表を使用して表示される入力フィールドを構成します。
入力フィールドの変更は自動的に保存されます。
タスクの入力パラメータ
次のテーブルに、Firestore - Document Get タスクの入力パラメータを示します。
| プロパティ | データ型 | 説明 |
|---|---|---|
| Region | 文字列 | Firestore データベースのロケーション。例: us-central1 |
| ProjectsId | 文字列 | Google Cloud プロジェクト ID。 |
| DatabasesId | 文字列 | Firestore データベースの ID。 |
| DocumentsId | 文字列 | Firestore ドキュメントのパスまたは場所。 |
使用可能なオプションのクエリ パラメータについては、クエリ パラメータをご覧ください。
タスク出力
Firestore - Document Get タスクは、ドキュメント データを base64 エンコード形式で返します。出力文字列を取得するには、Base64 エンコード値をデコードする必要があります。
エラー処理方式
タスクのエラー処理方法では、一時的なエラーによってタスクが失敗した場合のアクションを指定します。エラー処理方式の使用方法と、さまざまな種類のエラー処理方式の詳細については、エラー処理の方式をご覧ください。
次のステップ
- エッジとエッジの条件を追加する。
- インテグレーションをテストして公開する。
- トリガーを構成する。
- データ マッピング タスクを追加する。
- Google Cloud サービス向けのすべてのタスクを確認する。