68. HTML Service dialogs
Module 14 · 20 minutes · Lesson 67; earlier service and JavaScript fundamentals
Open Interactive LessonDiscover
How can you use html service dialogs without changing the wrong data?
- Explain html service dialogs in your own words
- Trace the actual ui state change from the source
- Repair the supplied failing operation and verify the result
Predict
Which values or resources will change, and which should stay unchanged? Write your prediction before execution.
Understand
HTML Service returns an HtmlOutput object, not a live DOM in server JavaScript. Display it through a bound editor UI or return it from doGet for a web app. Keep untrusted data out of raw HTML strings unless escaped. The academy preview is sandboxed and cannot access parent storage or Google services.
Example 1: Working automation
A dialog record contains the title and authored HTML. No actual Google dialog opens locally.
function main() {
const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: SpreadsheetApp.getUi().showModalDialog(output, "Report review");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 4: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [],
"error": null,
"resource": "ui",
"value": {
"type": "dialog",
"title": "Report review",
"content": "<h1>Review report</h1><p>Check totals before export.</p>"
}
}Example 2: Investigate a reproducible failure
Predict the effect of <h1>Wrong report</h1> and identify the first mismatch. This example is intentionally faulty.
function main() {
const output = HtmlService.createHtmlOutput("<h1>Wrong report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}Important line explanations
- Line 1: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const output = HtmlService.createHtmlOutput("<h1>Wrong report</h1><p>Check totals before export.</p>");
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: SpreadsheetApp.getUi().showModalDialog(output, "Report review");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 4: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [],
"error": null,
"resource": "ui",
"value": {
"type": "dialog",
"title": "Report review",
"content": "<h1>Wrong report</h1><p>Check totals before export.</p>"
}
}Example 3: Separate setup from execution and inspect repeat behavior
Call the same named operation twice. Compare outputs and resource counts to learn whether this operation is idempotent. Repeated creation is deliberately visible; real exports require a rerun policy.
function lessonAction() {
const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}
function main() {
lessonAction();
lessonAction();
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: SpreadsheetApp.getUi().showModalDialog(output, "Report review");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 4: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 5: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 6: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 7: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 8: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [],
"error": null,
"resource": "ui",
"value": {
"type": "dialog",
"title": "Report review",
"content": "<h1>Review report</h1><p>Check totals before export.</p>"
}
}Example 4: Add a diagnostic boundary around the operation
Observe start, successful completion or a rethrown failure. This optional professional pattern adds error context without swallowing the error or rolling back changes.
function lessonAction() {
const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}
function main() {
console.log("Start: HTML Service dialogs");
try { lessonAction(); console.log("Completed operation"); }
catch(error) { console.error("Failed operation: " + error.message); throw error; }
}Important line explanations
- Line 1: function lessonAction() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 2: const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: SpreadsheetApp.getUi().showModalDialog(output, "Report review");
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 4: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 5: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 6: console.log("Start: HTML Service dialogs");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 7: try { lessonAction(); console.log("Completed operation"); }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 8: catch(error) { console.error("Failed operation: " + error.message); throw error; }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 9: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Start: HTML Service dialogs",
"Completed operation"
],
"error": null,
"resource": "ui",
"value": {
"type": "dialog",
"title": "Report review",
"content": "<h1>Review report</h1><p>Check totals before export.</p>"
}
}Build and test
Repair the supplied script so that: A dialog record contains the title and authored HTML. No actual Google dialog opens locally. Preserve other source data. Checks compare observable output and the named resource, not exact source text.
function main() {
const output = HtmlService.createHtmlOutput("<h1>Wrong report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}Graduated hints
Hint 1
Inspect the operation containing <h1>Wrong report</h1>. Compare it with the stated rule and the first mismatch.
Hint 2
The repair concerns <h1>Review report</h1>. Change only the relevant argument, operator or method; rerun with fresh input.
Hint 3
The reference uses <h1>Review report</h1> where the broken source uses <h1>Wrong report</h1>. Explain why before applying it.
Reference solution
function main() {
const output = HtmlService.createHtmlOutput("<h1>Review report</h1><p>Check totals before export.</p>");
SpreadsheetApp.getUi().showModalDialog(output, "Report review");
}Explain and reflect
Which operation proves the intended result in html service dialogs? Which wrong input would expose a weakness, and what would remain unchanged?
Adapt the input records and ui output to a second realistic case. Write its expected result before running. Demonstrate one invalid case and explain whether the side effects should be rolled back or retried.
Troubleshooting
If the console is empty, inspect the ui preview: this script may work through state changes. If the function is missing, select main. For a service error inspect the first failed timeline entry and its arguments. Use Manual unless investigating a trigger. Changing input data also changes the expected result; restore sample data before the authored checks.
Knowledge check
Explain the key method or operator. Give an exact output for a second input, plus one invalid case. Verify the result in the interactive lesson; written explanations need self or educator review.
Optional AI practice
Explain this concept using the source above. Help implement one small extension and define its tests. Review/debug the source using its actual expected output; cite real method references and never claim execution.