Przekazywanie danych między krokami za pomocą zmiennej wyjściowej

Z tego przewodnika dowiesz się, jak utworzyć zmienną wyjściową.

Zmienne wyjściowe są zwracane przez kroki i mogą być przesyłane do innego kroku. Możesz na przykład przekazać adres e-mail do innego kroku, który użyje go do określenia adresata e-maila.

Zdefiniuj zmienną wyjściową w 2 miejscach: w pliku manifestu dodatku i w kodzie za pomocą funkcji, która zwraca zmienną wyjściową.

Poniższy przykład zwraca obliczony wynik matematyczny na podstawie 3 zmiennych wejściowych: 2 liczb i działania arytmetycznego.

Zdefiniuj zmienną wyjściową w pliku manifestu

W pliku manifestu Apps Script określ tablicę outputs[] i onExecuteFunction().

Każdy element w tablicy outputs[] ma te właściwości:

  • id: niepowtarzalny identyfikator zmiennej wyjściowej.
  • description: opis zmiennej wyjściowej, który będzie wyświetlany użytkownikom.
  • cardinality: ile wartości jest dozwolonych. Możliwe wartości:
    • "SINGLE": dozwolona jest tylko jedna wartość.
  • dataType: typ akceptowanych wartości. dataType ma właściwość basicType, która określa typ danych. Prawidłowe wartości to:
    • "STRING": ciąg alfanumeryczny.
    • "INTEGER": liczba.
    • "TIMESTAMP": sygnatura czasowa w formacie ISO 8601. Na przykład w ISO 8601 15 marca 2025 roku jest zapisywany jako 2025-03-15.
    • "BOOLEAN": wartość true lub false.
    • "EMAIL_ADDRESS": adres e-mail w formacie dana@example.com.

W tym przykładzie zdefiniowano zmienną wyjściową dla kroku kalkulatora. Zmienna wyjściowa jest liczbą całkowitą.

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

Zdefiniuj zmienną wyjściową w kodzie

Kod kroku zawiera funkcję o nazwie onExecuteCalculate(), która jest onExecuteFunction zdefiniowaną w manifeście. Wykonuje działania arytmetyczne na 2 wartościach wprowadzonych przez użytkownika i zwraca wynik jako zmienną wyjściową z funkcją o nazwie outputVariables().

Aby zwrócić zmienną wyjściową, zwróć JSON spełniający te wymagania:

  • variableId każdej zmiennej wyjściowej musi być zgodny z id odpowiedniej zmiennej wyjściowej w pliku manifestu.
  • variableData zmiennej wyjściowej musi być zgodny z dataType i cardinality odpowiedniej zmiennej wyjściowej w pliku manifestu.

Poniższy przykład zwraca zmienną wyjściową, która jest wartością arytmetyczną 2 liczb wejściowych:

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