Transmitir dados entre etapas com uma variável de saída

Este guia explica como criar uma variável de saída.

As variáveis de saída são retornadas por etapas e podem ser enviadas para outra etapa. Por exemplo, transmita um endereço de e-mail para outra etapa que o usa para especificar o destinatário de um e-mail.

Defina a variável de saída em dois lugares: no arquivo de manifesto do complemento e no código com uma função que retorna a variável de saída.

O exemplo a seguir retorna um resultado matemático calculado de três variáveis de entrada: dois números e uma operação aritmética.

Definir a variável de saída no arquivo de manifesto

No arquivo de manifesto do Apps Script, especifique uma matriz outputs[] e um onExecuteFunction().

Cada item na matriz outputs[] tem estas propriedades:

  • id: identificador exclusivo de uma variável de saída.
  • description: uma descrição da variável de saída para mostrar aos usuários finais.
  • cardinality: quantos valores são permitidos. Os valores possíveis são:
    • "SINGLE": apenas um valor é permitido.
  • dataType: o tipo de valores aceitos. dataType tem a propriedade basicType, que define o tipo de dados. Alguns dos valores válidos são:
    • "STRING": uma string alfanumérica.
    • "INTEGER": um número.
    • "TIMESTAMP": um carimbo de data/hora no formato ISO 8601. Por exemplo, no ISO 8601, 15 de março de 2025 é representado como 2025-03-15.
    • "BOOLEAN": verdadeiro ou falso.
    • "EMAIL_ADDRESS": um endereço de e-mail no formato dana@example.com.

O exemplo a seguir define uma variável de saída para uma etapa da calculadora. A variável de saída é um número inteiro.

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"
          }
        }
      ]
    }
  }
}

Definir a variável de saída no código

O código da etapa inclui uma função chamada onExecuteCalculate(), que é o onExecuteFunction definido no manifesto. Ela realiza operações aritméticas em dois valores inseridos pelo usuário e retorna o resultado como uma variável de saída com uma função chamada outputVariables().

Para retornar uma variável de saída, retorne JSON com os seguintes requisitos:

  • O variableId de cada variável de saída precisa corresponder ao id da variável de saída correspondente no arquivo de manifesto.
  • O variableData da variável de saída precisa corresponder ao dataType e cardinality da variável de saída correspondente no arquivo de manifesto.

O exemplo a seguir retorna uma variável de saída que é o valor aritmético de dois números de entrada:

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