現在のプランを確認
Suite、すべてのバージョン Team、Growth、Professional、EnterpriseまたはEnterprise Plus
Support Team、ProfessionalまたはEnterprise
この記事で説明する機能は、2026年5月11日から6月12日にかけて、すべてのSuiteプランおよびSupportプランを対象に順次利用可能になります。そのため、お客様のアカウントではこの機能がまだ表示されない場合があります。詳しくは、こちらの製品関連の告知をご覧ください。

インテグレーションビルダーを使用する場合、APIリクエスト本文で、文字列、数値、ブール値、配列などの型のリクエストパラメータを渡すことができます。この機能により、APIインテグレーションの柔軟性が高まり、より幅広いユースケースに対応できるようになります。この記事では、これらのパラメータを設定する手順を説明します。

この記事では、次のトピックについて説明します。

  • リクエストパラメータの型を設定する
  • 配列パラメータの再フォーマットを追加する
  • APIコールのリクエスト本文でパラメータを使用する
  • 設定をテストする

関連記事

  • インテグレーションビルダー関連のリソース

リクエストパラメータの型を設定する

リクエストパラメータの型を設定するには

  1. インテグレーションビルダーの「リクエストパラメータ」セクションに移動します。
  2. パラメータを定義し、その型を以下のいずれかに設定します。
    • 文字列:引用符で囲まれたテキストデータ(例:"example text")。
    • 数値:数値(例:123)。
    • ブール値:true/false の値。
    • 配列:値のコレクション(例:["item1", "item2"])。

配列パラメータの再フォーマットを追加する

インテグレーションビルダーで配列型のパラメータをテストする場合は、データ型が適切に処理されるように、再フォーマット関数を追加する必要があります。それには、次の関数を使用します。

$eval($)

この関数は、文字列値を配列オブジェクトに解析します。

パラメータがすでに配列オブジェクトである場合、この関数によって動作が変わることはありません。

詳細については、「AIエージェント向けリクエストパラメータ値の再フォーマット」を参照してください。

APIコールのリクエスト本文でパラメータを使用する

APIコールのリクエスト本文では、これらのパラメータを文字列パラメータと同じ形式で使用できます。構文は {{<REQUEST_PARAMETER>}} です。

以下のスクリーンショットにあるように、リクエスト本文ではパラメータが文字列として表示される場合がありますが、実行時には、「リクエストパラメータ」セクションで指定した対応するデータ型に変換されます。

設定をテストする

インテグレーションビルダーの「本番環境をテスト」ボタンを使用して、APIコールを実行します。

リクエストで、パラメータが正しい型(文字列、数値、ブール値、配列)で渡されていることを確認します。

レスポンスを確認し、APIによって適切に処理されていることを確認します。

メモ:変換が正常に行われるかどうかは、パラメータの型と再フォーマット関数が正しく設定されているかどうかによって決まります。設定が誤っていると、APIコールでエラーが発生する可能性があります。

 

Powered by Zendesk