Aktivitäten und Fehler protokollieren

In diesem Leitfaden wird beschrieben, wie Sie benutzerdefinierte Logs und Fehlermeldungen schreiben, die bei der Fehlerbehebung eines Flow-Schritts helfen, der auf dem Tab „Aktivität“ von Flows nicht ausgeführt werden kann.

Auf dem Tab „Aktivität“ wird standardmäßig der Name des Schritts protokolliert, der gemäß der Manifestdatei ausgeführt wird. Damit Sie nachvollziehen können, was während eines Schrittlaufs passiert ist, sollten Sie auch benutzerdefinierte Logs für Ihren Schritt schreiben. Wenn Nutzer beim Ausführen Ihres Schritts auf unerwartetes Verhalten stoßen, können sie anhand Ihrer Protokolle nachvollziehen, was passiert ist.

Ein hilfreicher Logeintrag hat zwei Attribute:

  • Ein Chip mit einem Hyperlink zur Ressource, die durch den Schritt erstellt oder aktualisiert wurde. Wenn in Ihrem Schritt beispielsweise ein Google-Dokument erstellt wird, können Sie mit dem Chip einen Link zum erstellten Google-Dokument einfügen.
  • Eine detaillierte Fehlermeldung, die beschreibt, warum ein Schritt nicht ausgeführt wurde und wie das Problem behoben werden kann.

Das folgende Codebeispiel zeigt, wie die onExecuteFunction() eines Schritts einen erfolgreichen Lauf und einen Fehler auf dem Tab „Aktivität“ protokollieren kann:

Apps Script

function onExecuteFunctionCreateDocument(e) {

  // true if the document is successfully created, false if something goes wrong.
  var successfulRun = createDocument();

  // If successful, return an activity log linking to the created document.
  if (successfulRun == true) {
    return {
      "hostAppAction": {
        "workflowAction": {
          "returnOutputVariablesAction": {
            "variableValues": [
              {}
            ],
            "log": {
              "textFormatElements": [
                {
                  "text": "Created Google Doc"
                },
                {
                  "chip": {
                    "icon": {
                      "materialIconName": "edit_document"
                    },
                    "url": "https://docs.google.com/document/d/{DOCUMENT}",
                    "label": "{NAMEOFDOCUMENT}"
                  }
                },
                {
                  "text": "Created doc detailing how to improve product."
                }
              ]
            },
            "trigger_log": {
              "textFormatElements": [
                {
                  "text": "Email log "
                }
              ]
            }
          }
        }
      }
    };
  }

  // Otherwise, return an activity log containing an error explaining what happened and how to resolve the issue.
  else {
    return {
      "hostAppAction": {
        "workflowAction": {
          "returnElementErrorAction": {
            "errorActionability": "NOT_ACTIONABLE",
            "errorRetryability": "NOT_RETRYABLE",
            "error_log": {
              "textFormatElements": [
                {
                  "text": "Failed to create Google Doc"
                },
                {
                  "chip": {
                    "icon": {
                      "materialIconName": "document"
                    },
                    "label": "{NAMEOFDOCUMENT}"
                  }
                },
                {
                  "text": "Unable to create Google Document because OAuth verification failed. Grant one of these authorization scopes and try again: https://www.googleapis.com/auth/documents, https://www.googleapis.com/auth/drive, https://www.googleapis.com/auth/drive.file"
                }
              ]
            }
          }
        }
      }
    };
  }
}