SDKリファレンス - custom_action
このセクションでは、カスタムアクションを定義するために使用できるすべてのキーを列挙します。
クイック概要
custom_actionキーを使用すると、標準アクションが利用できない場合に、コネクタのユーザーが作業を進められるようにカスタムアクションをすばやく定義できます。 これらのアクションでは、関連するAPIエンドポイントやペイロードスキーマの見つけ方など、特定のAPIの概念をユーザーが理解している必要があることに注意してください。
構造
ruby
custom_action: Boolean,
custom_action_help: {
learn_more_url: String,
learn_more_text: String,
body: String
}custom_action
| 属性 | 説明 |
|---|---|
| キー | custom_action |
| タイプ | ブール値 |
| 必須 | 任意です。 デフォルトはfalseで、コネクタにカスタムアクションは追加されません。 ユーザー向けのオプションとしてカスタムアクションを追加するには、trueに設定します。 |
| 説明 | これにより、コネクタにカスタムアクションが追加されます。 |
| 想定される出力 | Boolean 例: true |
| UIリファレンス |  |
custom_action_help
| 属性 | 説明 |
|---|---|
| キー | custom_action_help |
| タイプ | ハッシュ |
| 必須 | 任意です。 custom_actionがtrueの場合、このハッシュを使用してアクション内のヘルプテキストをカスタマイズできます。 |
| 説明 | ヘルプ本文、ヘルプボタンのURL、およびラベルを設定できます。 |
| 想定される出力 | Hash 詳細は以下を参照してください |
| UIリファレンス |  |
TIP
カスタムアクションのヘルプは、APIドキュメントなどの情報を収集するための適切なWebサイトにユーザーを誘導するうえで重要です。
learn_more_url
| 属性 | 説明 |
|---|---|
| キー | learn_more_url |
| タイプ | 文字列 |
| 必須 | 任意です。 |
| 説明 | ユーザーがカスタムアクション内のヘルプリンクをクリックしたときに移動するURLを定義します。 |
| 想定される出力 | 'www.api-reference.com' |
learn_more_text
| 属性 | 説明 |
|---|---|
| キー | learn_more_text |
| タイプ | 文字列 |
| 必須 | 任意です。 |
| 説明 | ヘルプ内のハイパーリンクテキストのラベル。 |
| 想定される出力 | 'API documentation' |
body
| 属性 | 説明 |
|---|---|
| キー | body |
| タイプ | 文字列 |
| 必須 | 任意です。 |
| 説明 | learn moreボタンの上に表示されるメインのヘルプテキスト本文。 この本文はHTML互換です。 |
| 想定される出力 | '<p>HTTPリクエストで独自のChargebeeアクションを作成します。 <b>リクエストはChargebee Hanaコネクションで認可されます。</b></p> |
Last updated: