Passare dati tra i passaggi con una variabile di output

Questa guida spiega come creare una variabile di output.

Le variabili di output vengono restituite dai passaggi e possono essere inviate a un altro passaggio. Ad esempio, passa un indirizzo email a un altro passaggio che lo utilizza per specificare il destinatario di un'email.

Definisci la variabile di output in due posizioni: nel file manifest del componente aggiuntivo e nel codice con una funzione che restituisce la variabile di output.

L'esempio seguente restituisce un risultato matematico calcolato da tre variabili di input: due numeri e un'operazione aritmetica.

Definisci la variabile di output nel file manifest

Nel file manifest di Apps Script, specifica un array outputs[] e un onExecuteFunction().

Ogni elemento dell'array outputs[] ha le seguenti proprietà:

  • id: identificatore univoco per una variabile di output.
  • description: una descrizione della variabile di output da mostrare agli utenti finali.
  • cardinality: quanti valori sono consentiti. I valori possibili sono:
    • "SINGLE": è consentito un solo valore.
  • dataType: il tipo di valori accettati. dataType ha la proprietà basicType che definisce il tipo di dati. I valori validi includono:
    • "STRING": una stringa alfanumerica.
    • "INTEGER": un numero.
    • TIMESTAMP: un timestamp nel formato "millisecondi dall'epoca Unix". Ad esempio, il 27 novembre 2025 alle ore 16:49:02 UTC è rappresentato come 1764262142988.
    • "BOOLEAN": true o false.
    • "EMAIL_ADDRESS": Un indirizzo email nel formato dana@example.com.

L'esempio seguente definisce una variabile di output per un passaggio del calcolatore. La variabile di output è un numero intero.

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

Definisci la variabile di output nel codice

Il codice del passaggio include una funzione chiamata onExecuteCalculate(), che è onExecuteFunction definita nel manifest. Esegue operazioni aritmetiche su due valori inseriti dall'utente e restituisce il risultato come variabile di output con una funzione chiamata outputVariables().

Per restituire una variabile di output, restituisci JSON con i seguenti requisiti:

  • Il variableId di ogni variabile di output deve corrispondere al id della variabile di output corrispondente nel file manifest.
  • Il variableData della variabile di output deve corrispondere a dataType e cardinality della variabile di output corrispondente nel file manifest.

L'esempio seguente restituisce una variabile di output che è il valore aritmetico di due numeri di input:

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 onExecuteCalculate(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;
  }
  const variableData = AddOnsResponseService.newVariableData()
    .addIntegerValue(calculatedValue);
  
  const workflowAction = AddOnsResponseService.newReturnOutputVariablesAction()
    .addVariableData("result", variableData);

  const hostAppAction = AddOnsResponseService.newHostAppAction()
    .setWorkflowAction(workflowAction);

  return AddOnsResponseService.newRenderActionBuilder()
    .setHostAppAction(hostAppAction)
    .build();
}