Ghi nhật ký hoạt động và lỗi

Hướng dẫn này giải thích cách viết nhật ký tuỳ chỉnh và thông báo lỗi giúp khắc phục sự cố bước trong luồng không chạy được trong thẻ Hoạt động của luồng.

Theo mặc định, thẻ Hoạt động sẽ ghi nhật ký tên của bước chạy như được xác định trong tệp kê khai của bước đó. Để hiểu rõ những gì đã xảy ra trong quá trình chạy một bước, bạn cũng nên viết nhật ký tuỳ chỉnh cho bước đó. Nếu người dùng gặp phải hành vi không mong muốn trong khi chạy bước của bạn, thì nhật ký có thể giúp họ hiểu rõ những gì đã xảy ra.

Một mục nhập nhật ký hữu ích có 2 thuộc tính:

  • Một khối chứa siêu liên kết đến tài nguyên được tạo hoặc cập nhật theo bước. Ví dụ: nếu bước của bạn tạo một tệp Google Tài liệu, hãy dùng khối này để liên kết đến tệp Google Tài liệu đã tạo.
  • Một thông báo lỗi chi tiết mô tả lý do một bước không chạy được và cách giải quyết vấn đề.

Mã mẫu sau đây cho biết cách onExecuteFunction() của một bước có thể ghi lại một lần chạy thành công và một lỗi vào thẻ Activity (Hoạt động):

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