Panduan ini menjelaskan cara menulis log kustom dan pesan error yang membantu memecahkan masalah langkah alur yang gagal dijalankan di tab Aktivitas alur.
Secara default, tab Aktivitas mencatat nama langkah yang berjalan seperti yang ditentukan dalam file manifesnya. Untuk membantu Anda memahami apa yang terjadi selama menjalankan langkah, Anda juga harus menulis log kustom untuk langkah Anda. Jika pengguna mengalami perilaku yang tidak terduga saat menjalankan langkah Anda, log Anda dapat membantu mereka memahami apa yang terjadi.
Entri log yang bermanfaat memiliki dua atribut:
- Chip yang berisi hyperlink ke resource yang dibuat atau diperbarui oleh langkah tersebut. Misalnya, jika langkah Anda membuat Google Dokumen, gunakan chip untuk menautkan ke Google Dokumen yang dibuat.
- Pesan error mendetail yang menjelaskan alasan langkah gagal dijalankan dan cara menyelesaikan masalah.
Contoh kode berikut menunjukkan cara onExecuteFunction() langkah mencatat keberhasilan
dan error ke tab Aktivitas:
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"
}
]
}
}
}
}
};
}
}