SDK リファレンス - custom_action

このセクションでは、カスタムアクションを定義するときに使用できるすべてのキーを列挙します。

簡単な概要

custom_action キーを使用すると、標準のアクションが利用できない場合にカスタムアクションを速やかに定義して、コネクターのユーザーが直面する障害を解消することができます。ただし、このアクションを使用するユーザーは、関連する API エンドポイントやペイロードスキーマの見つけ方など、一定の API コンセプトを理解する必要があります。

構造

    custom_action: Boolean,
    
    custom_action_help: {
      learn_more_url: String,

      learn_more_text: String,

      body: String
    }

---

custom_action

属性	説明
キー	custom_action
型	Boolean
必須	任意。デフォルトは false で、コネクターに追加されるカスタムアクションはありません。ユーザーへのオプションとしてカスタムアクションを追加するには、true に設定してください。
説明	これにより、コネクターにカスタムアクションが追加されます。
期待される出力	Boolean つまり true
UI リファレンス

---

custom_action_help

属性	説明
キー	custom_action_help
型	Hash
必須	任意。custom_action が true の場合、このハッシュによってアクション内のヘルプテキスをカスタマイズできます。
説明	ヘルプ文、ヘルプボタンの URL およびラベルを設定できます。
期待される出力	Hash 詳細は以下を参照してください。
UI リファレンス

TIP

カスタムアクションのヘルプは、API ドキュメントのような情報を収集するための適切な Web サイトにユーザーを誘導するうえで重要です。

---

learn_more_url

属性	説明
キー	learn_more_url
型	String
必須	任意。
説明	カスタムアクションのヘルプリンクをクリックしたときにユーザーに送信する URL を定義します。
期待される出力	'www.api-reference.com'

---

learn_more_text

属性	説明
キー	learn_more_text
型	String
必須	任意。
説明	ヘルプ内のハイパーリンクテキストのラベル。
期待される出力	'API documentation'

---

body

属性	説明
キー	body
型	String
必須	任意。
説明	詳細ボタンの上に表示されるメインヘルプのテキスト本文です。この本文は HTML 対応です。
期待される出力	'<p>Build your own Chargebee action with a HTTP request. <b>The request will be authorized with your Chargebee Hana connection.</b></p>