# WorkatoによるRubyスニペット

Rubyはウェブ開発で人気のある言語です。Ruby snippets by Workatoコネクタを使用すると、カスタムRubyコードを作成し、それをレシピに挿入してカスタムアクションを実行することができます。これにより、Rubyを使用して外部サービスの呼び出しなどのアクションを実行することができます。

ALLOWLISTED RUBY METHODS ONLY

Only allowlisted Ruby methods can be added to your recipe. Refer to Available Ruby methods for more information.

Ruby snippets by Workatoコネクタを使用するための接続の設定は必要ありません。

Ruby snippets by WorkatoWorkatoによるRubyスニペット

# 必要なセクション

セクション 説明
Name アクションの目的を示す説明的な名前を提供します。例えば、Get account details
Input このセクションを使用して、Rubyコードにデータを渡します。
Output schema このセクションを使用して、Rubyコードが出力するデータ構造を定義します。
Code このセクションを使用して、実行する予定のRubyコードを追加します。このコードは、Inputセクションで渡されたデータを使用し、Output schemaセクションで定義された構造に一致するハッシュを返す必要があります。

# 制限事項

Ruby snippets by Workatoコネクタを使用する際、以下の制限事項が適用されます:

  • スクリプトは1MBを超えることはできません。大きなスクリプトはメモリの問題を引き起こす可能性があります。
  • コードスニペットは、ライブラリ、一時メモリ、入力を含め、合計メモリ制限が256MBです。
  • 30秒以上実行されると、アクションは終了します。
  • ユーザーが提供するライブラリはサポートされていません。

# Input

RubyスニペットのInputセクションでは、Rubyコードにデータを渡すことができます。これは、レシピ内の前のステップからのデータや、Rubyコード内で使用する予定の他のデータである場合があります。Rubyコード内でinputキーワードを使用して、Inputセクションのデータにアクセスできます。

InputInputセクション

アクションで使用する予定の入力フィールドを定義する必要があります:

1

Inputセクションに移動します。

2

Add fieldをクリックします。

3

入力にLabelを追加します。

Add field新しいフィールドを追加

4

Data typeドロップダウンメニューを使用して、stringやbooleanなど、使用する予定のデータ型を選択します。

5

オプション。Hintフィールドに説明を入力するか、ユーザーを支援するための追加のコンテキストを提供します。

6

Add fieldをクリックして、入力フィールドをアクションに追加します。

7

Rubyコードに渡す予定のすべての入力フィールドについて、これらの手順を繰り返します。

# Output schema

出力スキーマは、Rubyコードが出力するデータ構造を定義します。これは、Rubyコードの出力を後続のレシピの手順で使用する予定がある場合に役立ちます。

アクションを実行するためにRuby snippets by Workatoを使用する場合、コードの出力スキーマを定義する必要があります。出力スキーマは出力データツリーを構築し、Ruby関数から返されたデータを後続のレシピアクションで使用できるようにします。

Output schema出力スキーマ

出力スキーマは、サンプルJSONを使用するか、出力フィールドを手動で定義することで構成できます。

# 出力フィールドを手動で定義する

出力スキーマにフィールドを手動で追加するために、以下の手順を完了します:

1

Output schemaセクションに移動します。

2

Add fields manuallyをクリックします。

Add fields manually出力スキーマを手動で定義する

3

フィールドのNameを入力します。

4

オプション。入力にLabelを追加します。

5

Data typeドロップダウンメニューを使用して、stringやbooleanなど、使用する予定のデータ型を選択します。

6

Optionalドロップダウンメニューを使用して、フィールドがオプションか必須かを選択します。

7

オプション。Nest underドロップダウンメニューを使用して、フィールドをネストする場所を選択します。

8

オプション。Hintフィールドに説明を入力するか、ユーザーを支援するための追加のコンテキストを提供します。

9

Add fieldをクリックして、このフィールドを出力スキーマに追加します。

10

Rubyコードに渡す予定のすべてのフィールドについて、これらの手順を繰り返します。

# サンプルJSONを使用する

サンプルJSONで出力スキーマを構成するために、以下の手順を完了します:

1

Use JSONボタンをクリックして、スキーマ生成ウィザードを開きます。

Sample JSONサンプルJSONで出力スキーマを定義する

2

ウィンドウに使用する予定のJSONサンプルを貼り付け、Nextをクリックします。

3

JSONサンプルを確認し、Generate schemaをクリックします。出力データツリーがOutputフィールドに表示されます。

# コード

Codeフィールドは、レシピが実行するRubyコードを記述する場所です。このコードはInputフィールドのデータを使用でき、Output schemaフィールドで定義された構造に一致するハッシュを返す必要があります。返されるハッシュのキーはOutput schemaのフィールド名と一致している必要があり、対応する値にはそれらのフィールドのデータが含まれます。

Code sectionRubyコードを追加する


Last updated: 2025/3/13 6:42:56