DiscoveryVIP / Apps Script AcademyHelp

69. Interactive sidebars

Module 14 · 20 minutes · Lesson 68; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use interactive sidebars without changing the wrong data?

Predict

Which values or resources will change, and which should stay unchanged? Write your prediction before execution.

Understand

A sidebar is an HTML interface beside the host document. Its client JavaScript runs separately from server Apps Script. Use google.script.run callbacks for server data, not direct SpreadsheetApp calls in the page. The Web Application Studio provides an actual local asynchronous bridge for supported examples.

Example 1: Working automation

The sidebar state contains a distinct interface, while server and client environments remain separate.

function main() {
  const output = HtmlService.createHtmlOutput("<h2>Administration</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}
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("<h2>Administration</h2><p>Review sample records.</p>");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: SpreadsheetApp.getUi().showSidebar(output);
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": "sidebar",
    "content": "<h2>Administration</h2><p>Review sample records.</p>"
  }
}

Example 2: Investigate a reproducible failure

Predict the effect of <h2>Unrelated</h2> and identify the first mismatch. This example is intentionally faulty.

function main() {
  const output = HtmlService.createHtmlOutput("<h2>Unrelated</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}
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("<h2>Unrelated</h2><p>Review sample records.</p>");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: SpreadsheetApp.getUi().showSidebar(output);
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": "sidebar",
    "content": "<h2>Unrelated</h2><p>Review sample records.</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("<h2>Administration</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}
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("<h2>Administration</h2><p>Review sample records.</p>");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: SpreadsheetApp.getUi().showSidebar(output);
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": "sidebar",
    "content": "<h2>Administration</h2><p>Review sample records.</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("<h2>Administration</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}
function main() {
  console.log("Start: Interactive sidebars");
  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("<h2>Administration</h2><p>Review sample records.</p>");
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: SpreadsheetApp.getUi().showSidebar(output);
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: Interactive sidebars");
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: Interactive sidebars",
    "Completed operation"
  ],
  "error": null,
  "resource": "ui",
  "value": {
    "type": "sidebar",
    "content": "<h2>Administration</h2><p>Review sample records.</p>"
  }
}

Build and test

Repair the supplied script so that: The sidebar state contains a distinct interface, while server and client environments remain separate. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const output = HtmlService.createHtmlOutput("<h2>Unrelated</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}

Graduated hints

Hint 1

Inspect the operation containing <h2>Unrelated</h2>. Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns <h2>Administration</h2>. Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses <h2>Administration</h2> where the broken source uses <h2>Unrelated</h2>. Explain why before applying it.

Reference solution

function main() {
  const output = HtmlService.createHtmlOutput("<h2>Administration</h2><p>Review sample records.</p>");
  SpreadsheetApp.getUi().showSidebar(output);
}

Explain and reflect

Which operation proves the intended result in interactive sidebars? 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.

Transfer to Google and authorization guide

Next lesson: Connecting HTML to server functions