Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Connector SDK
ハウツーガイド
アクションの構築

ハウツーガイド: オブジェクトの取得（Retrieve） ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

このセグメントでは、ターゲットアプリケーション内のオブジェクトの情報を取得するためのアクションの作成について説明します。 通常、GET HTTPリクエストメソッドは、オブジェクトを取得するリクエストの送信に使用されます。

アクションのタイムアウト

SDKアクションには180秒のタイムアウト制限があります。

サンプルコネクター - Zuora ​

ruby
{
  title: 'My Zuora connector',

  # More connector code here
  actions: {
    get_account: {
      title: "Get account",

      subtitle: "Retrieves details of an account in Zuora",

      description: lambda do |input, picklist_label|
        "Get an <span class='provider'>account</span> in " \
        "<span class='provider'>Zuora</span>"
      end,

      help: "Retrieves the information of an existing account in Zuora",

      input_fields: lambda do |object_definitions|
        [
          {
            name: "id",
            label: "Account ID",
            hint: "The ID of the specific account that you wish to retrieve."
          }
        ]
      end,

      execute: lambda do |connection, input|
        get("https://rest.zuora.com/v1/object/account/#{input["Id"]}", input).
          after_error_response(/.*/) do |_, body, _, message|
            error("#{message}: #{body}")
          end
      end,

      output_fields: lambda do |object_definitions|
        [
          # Various output fields
        ]
      end
    }
  }
  # More connector code here
}

アカウント取得アクションの選択アカウント取得アクションの選択

ステップ1 - アクションのタイトル、サブタイトル、説明、ヘルプ ​

優れたアクションを作成するための最初のステップは、アクションが何を行い、どのように実行するかを適切に伝え、ユーザーに追加のヘルプを提供することです。 そのため、Workatoではアクションのタイトルと説明を定義し、ヒントを提供できます。 簡単に言えば、タイトルはアクションのタイトルであり、サブタイトルはアクションの詳細を示します。 アクションの説明には、そのアクションが何を実現するかについての仕様と説明、および接続先アプリケーションのコンテキストが含まれます。 最後に、ヘルプセグメントでは、アクションを機能させるために必要な追加情報をユーザーに提供します。

このステップの詳細については、SDKリファレンスを参照してください

ステップ2 - 入力フィールドの定義 ​

ruby
  input_fields: lambda do |object_definitions|
    [
      {
        name: "id",
        label: "Account ID",
        hint: "The ID of the specific account that you wish to retrieve."
      }
    ]
  end

アカウント取得の入力フィールドアカウント取得の入力フィールド

このコンポーネントは、オブジェクトを取得しようとしているユーザーに表示するフィールドをWorkatoに指示します。 たとえばZuoraでアカウントを取得する場合、ユーザーは取得するアカウントのIDを入力する必要があります。

上記で定義したもの以外にも、入力/出力フィールドにはさまざまなキーと値のペアが存在します。 詳細については、入力フィールドを参照してください。

オブジェクト定義

object_definitionsが引数として渡されることに注意してください。 Workatoでは、コネクタービルダーがオブジェクトの定義を"object_definitions"キーで個別に指定できます。 このキーは、オブジェクトの定義が大きい場合や動的に取得できる場合に使用します。

この詳細については、SDKリファレンスを参照してください

ステップ3 - executeキーの定義 ​

executeキーは、リクエストの送信先エンドポイントと、使用するHTTPリクエストメソッドをWorkatoに指示します。 この例では、Getメソッドを使用して、リクエストをhttps://rest.zuora.com/v1/object/account/#{input["Id"]}に送信します。 また、リクエストにafter_error_responseメソッドを追加してエラーを捕捉し、レシピ作成中のデバッグに役立つようユーザーに表示します。

このgetアクションでは、ユーザーが入力したid（アカウントID）をAPIエンドポイントに追加し、取得する特定のアカウントをWorkato、続いてZuoraに伝えます。

ruby
  execute: lambda do |connection, input|
    get("https://rest.zuora.com/v1/object/account/#{input["id"]}", input).
      after_error_response(/.*/) do |_, body, _, message|
        error("#{message}: #{body}")
      end
  end

アカウント取得エラーエラーの例

executeキーの詳細については、SDKリファレンスを参照してください

ステップ4 - 出力フィールドの定義 ​

このセクションでは、トリガーの出力として表示するデータピルを指定します。 各データピルのname属性は、executeキーの出力に含まれるキーと一致している必要があります。

ruby
  output_fields: lambda do |object_definitions|
    [
      # Various output fields
    ]
  end

アカウント取得の出力フィールドアカウント取得の出力フィールド

output fieldsキーの詳細については、SDKリファレンスを参照してください

オブジェクト定義

object_definitionsが引数として渡されることに注意してください。 Workatoでは、コネクタービルダーがオブジェクトの定義を"object_definitions"キーで個別に指定できます。 このキーは、オブジェクトの定義が大きい場合や動的に取得できる場合に使用します。

この詳細については、SDKリファレンスを参照してください

Last updated: