出力変数を使用してステップ間でデータを渡す

このガイドでは、出力変数を作成する方法について説明します。

出力変数はステップによって返され、別のステップに送信できます。たとえば、メールアドレスを別のステップに渡し、そのステップでメールの受信者を指定します。

出力変数は、アドオンのマニフェスト ファイルと、出力変数を返す関数を含むコードの 2 か所で定義します。

次の例では、2 つの数値と 1 つの算術演算という 3 つの入力変数から計算された数学的結果を返します。

マニフェスト ファイルで出力変数を定義する

Apps Script のマニフェスト ファイルで、outputs[] 配列と onExecuteFunction() を指定します。

outputs[] 配列の各項目には次のプロパティがあります。

  • id: 出力変数の一意の識別子。
  • description: エンドユーザーに表示する出力変数の説明。
  • cardinality: 許可される値の数。指定できる値は次のとおりです。
    • "SINGLE": 1 つの値のみが許可されます。
  • dataType: 受け入れられる値のタイプ。dataType には、データの型を定義するプロパティ basicType があります。有効な値は次のとおりです。
    • "STRING": 英数字の文字列。
    • "INTEGER": 数値。
    • "TIMESTAMP": ISO 8601 形式のタイムスタンプ。たとえば、ISO 8601 では、2025 年 3 月 15 日は 2025-03-15 と表されます。
    • "BOOLEAN": true または false。
    • "EMAIL_ADDRESS": dana@example.com 形式のメールアドレス。

次の例では、計算ステップの出力変数を定義しています。出力変数は整数です。

JSON

{
  "timeZone": "America/Los_Angeles",
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "addOns": {
    "common": {
      "name": "Calculator",
      "logoUrl": "https://www.gstatic.com/images/branding/productlogos/calculator_search/v1/web-24dp/logo_calculator_search_color_1x_web_24dp.png",
      "useLocaleFromApp": true
    },
    "flows": {
      "workflowElements": [
        {
          "id": "actionElement",
          "state": "ACTIVE",
          "name": "Calculate",
          "description": "Asks the user for two values and a math operation, then performs the math operation on the values and outputs the result.",
          "workflowAction": {
            "inputs": [
              {
                "id": "value1",
                "description": "value1",
                "cardinality": "SINGLE",
                "dataType": {
                  "basicType": "INTEGER"
                }
              },
              {
                "id": "value2",
                "description": "value2",
                "cardinality": "SINGLE",
                "dataType": {
                  "basicType": "INTEGER"
                }
              },
              {
                "id": "operation",
                "description": "operation",
                "cardinality": "SINGLE",
                "dataType": {
                  "basicType": "STRING"
                }
              }
            ],
            "outputs": [
              {
                "id": "result",
                "description": "Calculated result",
                "cardinality": "SINGLE",
                "dataType": {
                  "basicType": "INTEGER"
                }
              }
            ],
            "onConfigFunction": "onConfigCalculate",
            "onExecuteFunction": "onExecuteCalculate"
          }
        }
      ]
    }
  }
}

コードで出力変数を定義する

ステップのコードには、マニフェストで定義されている onExecuteFunction である onExecuteCalculate() という関数が含まれています。ユーザーが入力した 2 つの値に対して算術演算を行い、outputVariables() という関数を使用して、結果を出力変数として返します。

出力変数を返すには、次の要件を満たす JSON を返します。

  • 各出力変数の variableId は、マニフェスト ファイル内の対応する出力変数の id と一致している必要があります。
  • 出力変数の variableData は、マニフェスト ファイル内の対応する出力変数の dataType および cardinality と一致している必要があります。

次の例では、2 つの入力数値の算術値である出力変数を返します。

Apps Script

/**
 * Executes the calculation step based on the inputs from a flow event.
 *
 * This function retrieves input values and the operation from the flow event,
 * performs the calculation, and returns the result as an output variable.
 * The function logs the event for debugging purposes.
 */
function onExecuteCalculateFunction(event) {
  console.log("output: " + JSON.stringify(event));
  var calculatedValue = 0;
  var value1 = event.workflow.actionInvocation.inputs["value1"];
  var value2 = event.workflow.actionInvocation.inputs["value2"];
  var operation = event.workflow.actionInvocation.inputs["operation"].stringValues[0];

  if (operation == "+") {
    calculatedValue = value1 + value2;
  } else if (operation == "-") {
    calculatedValue = value1 - value2;
  } else if (operation == "x") {
    calculatedValue = value1 * value2;
  } else if (operation == "/") {
    calculatedValue = value1 / value2;
  }
  var renderAction = {
    "hostAppAction" : {
      "workflowAction" : {
        "returnOutputVariablesAction" : {
          "variableValues" : [
            {
              "variableId": "result",
              "integerValues": [
                calculatedValue
              ]
            }
          ]
        }
      }
    }
  };

  console.log("renderAction: " + JSON.stringify(renderAction));

  return renderAction;
}