転送先としてカスタムコネクタを作成する

本ページでは、転送先としてカスタムコネクタを作成する手順について説明します。
接続情報や転送に関する設定については、以下のドキュメントを参照ください。

• 接続情報 - カスタムコネクタ
• 転送先 - カスタムコネクタ

入力項目

基本情報

コネクタ情報

認証情報

認証種別でOAuth2を選択した場合の追加項目

各認証種別で共通の項目

エンドポイント

カスタムコネクタで取得対象とするAPIのエンドポイントごとに設定を追加します。

詳細設定

接続確認

設定したエンドポイントの接続を確認できます。

パスの指定について

Liquidテンプレート構文を使用し、データ転送時のリクエスト先URLに変数を埋め込むことができます。
事前にIDを指定した上でレコードを追加したり、既存レコードのカラムの値をキーとしてレコードを更新したい場合に利用できます。

転送設定STEP2で設定するカラムをrow.カラム名 の形で変数として利用できます。

パスの展開結果は転送設定STEP2で確認できます。

リクエストテンプレートの定義について

Liquidテンプレート構文を使用し、リクエスト時のペイロードの内容を定義できます。

単一リクエストの場合

転送設定STEP2で設定するカラムをrow.カラム名 の形で参照します。

{
  "field1": "{{ row.column1 }}",
  "field2": "{{ row.column2 }}"
}

一括リクエストの場合

レコードのデータは rows に配列で格納されます。for文を利用して配列を展開し、各レコードを定義します。

{
  "records": [
    {% for row in rows %}
    {
      "field1": "{{ row.column1 }}",
      "field2": "{{ row.column2 }}",
      "field3": "{{ row.column3 }}"
    }{% unless forloop.last %},{% endunless %}
    {% endfor %}
  ]
}

テンプレートプレビューを利用すると、定義したテンプレートに値を指定し、ペイロードの内容を確認できます。

また、転送設定STEP2では、実際の転送元データによるプレビューも確認できます。