Application Integration でサポートされているコネクタをご覧ください。

API トリガー

API トリガーを使用して、統合の実行を直接呼び出します。

統合で API トリガーを構成すると、次のことができます。

API トリガーの使用を開始するには、API フルフィルメントのチュートリアルをご覧ください。このチュートリアルでは、顧客情報を取得するための API リクエストを受信する API トリガーとの統合を作成する方法について説明します。

API トリガーを追加する

統合に API トリガーを追加する手順は次のとおりです。
  1. Google Cloud コンソールで [Application Integration] ページに移動します。

    Application Integration に移動

  2. ナビゲーション メニューで [統合] をクリックします。

    [統合リスト] ページが開き、Google Cloud プロジェクトで使用可能なすべての統合が一覧表示されます。

  3. 既存の統合を選択するか、[統合の作成] をクリックして新しい統合を作成します。

    新しい統合を作成する場合:

    1. [統合の作成] ペインで名前と説明を入力します。
    2. 統合のリージョンを選択します。
    3. 統合用のサービス アカウントを選択します。統合のサービス アカウントの詳細は、統合ツールバーの [統合の概要] ペインでいつでも変更または更新できます。
    4. [作成] をクリックします。

    統合エディタで統合が開きます。

  4. 統合エディタのナビゲーション バーで、[トリガー] をクリックして、使用可能なトリガーのリストを表示します。
  5. [API trigger] 要素をクリックして、デザイナーに配置します。

API トリガーを構成する

API トリガーを構成するには、統合エディタで [API trigger] 要素をクリックします。API トリガーの構成ペインが表示され、次のフィールドが表示されます。

  • ラベル: 統合内の API トリガーの表示名。ラベルは任意の名前に変更できます。
  • 注: API トリガーにメモを追加して、トリガーに関する追加情報を提供できます。
  • トリガー ID: API トリガーに割り当てられる一意の ID（api_trigger/TRIGGER_NAME の形式）。
  • 入力変数: API トリガーのリクエスト ペイロードの設定に使用できるトリガー固有の入力変数。
    • 既存の統合変数を API トリガーに追加または削除するには、[変更] をクリックし、[API トリガーの入力変数] ペインから必要な変数を選択します。
    • 選択した API トリガーに新しい変数を追加するには、[変更] をクリックし、[API トリガーの入力変数] ペインで [+ 新しい変数を追加] を選択します。サポートされているデータ型については、サポートされている変数データ型をご覧ください。
  • 出力変数: API トリガーのレスポンス ペイロードの設定に使用できる、トリガー固有の出力変数。
    • 既存の統合変数を API トリガーに追加または削除するには、[変更] をクリックし、[API トリガーの出力変数] ペインで必要な変数を選択します。
    • 選択した API トリガーに新しい変数を追加するには、[変更] をクリックし、[API トリガーの出力変数] ペインで [+ 新しい変数を追加] を選択します。サポートされているデータ型については、サポートされている変数データ型をご覧ください。

API トリガーの OpenAPI 仕様を表示する

アプリケーション統合では、1 つ以上の API トリガーで構成された公開済みの統合の OpenAPI 仕様を動的に生成して表示できます。OpenAPI 仕様を表示する方法については、統合の OpenAPI 仕様を表示するをご覧ください。

API 呼び出しを使用して API トリガーを呼び出す

API トリガーが構成された統合を公開した後、projects.locations.integrations.execute メソッドを使用して任意のアプリケーションからそのトリガーを呼び出すことができます。 このメソッドは、同期モードで実行をトリガーします。

構文

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

次のように置き換えます。

  • TIMEOUT_SECONDS: API 呼び出しのタイムアウト（秒）。デフォルトのタイムアウトは 120 秒です。事前定義されたリクエスト パラメータのセットの一覧については、システム パラメータをご覧ください。
  • TRIGGER_NAME: 統合の API トリガーの名前。
  • PROJECT_ID: Google Cloud プロジェクトの ID。
  • LOCATION: Google Cloud プロジェクトのロケーション。

例

次の例では、demo-project Google Cloud プロジェクトの test_API_1 API トリガーを含む us-east1 リージョンでインテグレーションを呼び出します。

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

考慮事項

API トリガーを使用する場合、すべての入力変数の累積サイズは最大 8 MB です。サイズが 8 MB を超えると、Application Integration は統合を実行せず、エラーが発生します。

割り当てと上限

割り当てと上限については、割り当てと上限をご覧ください。

次のステップ