Передача данных между шагами с помощью выходной переменной

В этом руководстве объясняется, как создать выходную переменную.

Выходные переменные возвращаются по шагам и могут быть переданы на другой шаг. Например, можно передать адрес электронной почты на другой шаг, который использует его для указания получателя электронного письма.

Определите выходную переменную в двух местах: в файле манифеста дополнения и в коде с помощью функции, которая возвращает выходную переменную.

Следующий пример возвращает вычисленный математический результат из трех входных переменных: двух чисел и арифметической операции.

Определить выходную переменную в файле манифеста

В файле манифеста Apps Script укажите массив outputs[] и onExecuteFunction() .

Каждый элемент массива outputs[] имеет следующие свойства:

  • id : уникальный идентификатор выходной переменной.
  • description : Описание выходной переменной для отображения конечным пользователям.
  • cardinality : допустимое количество значений. Возможные значения:
    • "SINGLE" : допускается только одно значение.
  • dataType : Тип принимаемых значений. У dataType есть свойство basicType , которое определяет тип данных. Допустимые значения:
    • "STRING" : буквенно-цифровая строка.
    • "INTEGER" : число.
    • "TIMESTAMP" : временная метка в формате ISO 8601. Например, в ISO 8601 15 марта 2025 года представляется как 2025-03-15.
    • "BOOLEAN" : Либо «истина», либо «ложь».
    • "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"
          }
        }
      ]
    }
  }
}

Определить выходную переменную в коде

Код этого шага включает функцию onExecuteCalculate() , которая является функцией onExecuteFunction определённой в манифесте. Она выполняет арифметические операции над двумя введёнными пользователем значениями и возвращает результат в виде выходной переменной с помощью функции outputVariables() .

Чтобы вернуть выходную переменную, верните JSON со следующими требованиями:

  • variableId каждой выходной переменной должен совпадать с id соответствующей выходной переменной в файле манифеста.
  • variableData выходной переменной должно соответствовать dataType и cardinality соответствующей выходной переменной в файле манифеста.

Следующий пример возвращает выходную переменную, которая является арифметическим значением двух входных чисел:

Скрипт приложений 

/**
 * 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;
}