ثبت فعالیت‌ها و خطاها

این راهنما نحوه نوشتن گزارش‌های سفارشی و پیام‌های خطا را توضیح می‌دهد که به عیب‌یابی مرحله‌ای از جریان که در تب فعالیت جریان‌ها اجرا نمی‌شود، کمک می‌کند.

به طور پیش‌فرض، تب Activity نام مرحله‌ای که اجرا می‌شود را همانطور که در فایل manifest تعریف شده است، ثبت می‌کند. برای اینکه به شما در درک اتفاقات رخ داده در طول اجرای یک مرحله کمک کند، باید گزارش‌های سفارشی نیز برای مرحله خود بنویسید. اگر کاربران هنگام اجرای مرحله شما با رفتار غیرمنتظره‌ای مواجه شوند، گزارش‌های شما می‌توانند به آنها در درک آنچه اتفاق افتاده است کمک کنند.

یک ورودی مفید برای گزارش، دو ویژگی دارد:

  • تراشه‌ای حاوی یک هایپرلینک به منبعی که توسط مرحله ایجاد یا به‌روزرسانی شده است. برای مثال، اگر مرحله شما یک سند گوگل ایجاد می‌کند، از تراشه برای پیوند به سند گوگل ایجاد شده استفاده کنید.
  • یک پیام خطای دقیق که توضیح می‌دهد چرا یک مرحله اجرا نشد و چگونه می‌توان مشکل را حل کرد.

نمونه کد زیر نشان می‌دهد که چگونه onExecuteFunction() در یک مرحله می‌تواند یک اجرای موفق و یک خطا را در برگه Activity ثبت کند:

اسکریپت برنامه‌ها 

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