Application Integration でサポートされているコネクタをご覧ください。
API トリガー
API トリガーを使用して、統合の実行を直接呼び出します。API トリガーは、同期モードまたは非同期モードで使用できます。
API トリガーのリクエストとレスポンスのペイロードは、統合で変数を作成することで設定できます。顧客情報の取得のための API リクエストを受信する API トリガーとの統合を作成する方法については、API フルフィルメントのチュートリアルをご覧ください。
API トリガーを追加する
API トリガーを追加するには、次の操作を行います。- Google Cloud コンソールで [Application Integration] ページに移動します。
- ナビゲーション メニューで [統合] をクリックします。
[統合リスト] ページが開き、Google Cloud プロジェクトで使用可能なすべての統合が一覧表示されます。
- 既存の統合を選択するか、[統合の作成] をクリックして新しい統合を作成します。
新しい統合を作成する場合:
- [統合の作成] ペインで名前と説明を入力します。
- 統合のリージョンを選択します。
- 統合用のサービス アカウントを選択します。統合のサービス アカウントの詳細は、統合ツールバーの [統合の概要] ペインでいつでも変更または更新できます。
- [作成] をクリックします。
統合エディタで統合が開きます。
- 統合エディタのナビゲーション バーで、[トリガー] をクリックして、使用可能なトリガーのリストを表示します。
- [API trigger] 要素をクリックして、デザイナーに配置します。
API トリガーを構成する
統合デザイナーの API trigger 要素をクリックして、トリガー構成ペインを表示します。
構成パネルにトリガー ID が表示されます。これは、api_trigger/TRIGGER_NAME
の形式で自動生成された ID です。このトリガーに必要な設定はありません。
アプリケーションから 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 は統合を実行せず、エラーが発生します。
割り当てと上限
割り当てと上限については、割り当てと上限をご覧ください。
次のステップ
- すべてのタスクとトリガーを確認する。
- インテグレーションをテストして公開する方法について学習する。
- エラー処理について学習する。
- 統合の実行ログについて学習する。