DiscoveryVIP / Apps Script AcademyHelp

94. Editor add-ons and Workspace add-ons

Module 19 · 20 minutes · Lesson 93; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use editor add-ons and workspace add-ons without changing the wrong data?

Predict

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

Understand

Editor add-ons and Google Workspace add-ons use different UI models and publication requirements. HTML sidebars are not interchangeable with CardService cards. Host applications expose different capabilities. This sample builds a card structure locally; installing it requires a reviewed add-on manifest and host-specific entry point in Google.

Example 1: Working automation

A card has a header and section with a text widget. The structural JSON is not an installed add-on.

function main() {
  const section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}
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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: console.log(JSON.stringify(card));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 5: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"kind\":\"newCardBuilder\",\"children\":[{\"method\":\"setHeader\",\"value\":{\"kind\":\"newCardHeader\",\"children\":[{\"method\":\"setTitle\",\"value\":\"Discovery toolkit\"}]}},{\"method\":\"addSection\",\"value\":{\"kind\":\"newCardSection\",\"children\":[{\"method\":\"addWidget\",\"value\":{\"kind\":\"newTextParagraph\",\"children\":[{\"method\":\"setText\",\"value\":\"Review automation before applying changes.\"}]}}]}}]}"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of Unrelated toolkit and identify the first mismatch. This example is intentionally faulty.

function main() {
  const section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Unrelated toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}
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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Unrelated toolkit")).addSection(section).build();
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: console.log(JSON.stringify(card));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 5: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"kind\":\"newCardBuilder\",\"children\":[{\"method\":\"setHeader\",\"value\":{\"kind\":\"newCardHeader\",\"children\":[{\"method\":\"setTitle\",\"value\":\"Unrelated toolkit\"}]}},{\"method\":\"addSection\",\"value\":{\"kind\":\"newCardSection\",\"children\":[{\"method\":\"addWidget\",\"value\":{\"kind\":\"newTextParagraph\",\"children\":[{\"method\":\"setText\",\"value\":\"Review automation before applying changes.\"}]}}]}}]}"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}
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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: console.log(JSON.stringify(card));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 5: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 6: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
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: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"kind\":\"newCardBuilder\",\"children\":[{\"method\":\"setHeader\",\"value\":{\"kind\":\"newCardHeader\",\"children\":[{\"method\":\"setTitle\",\"value\":\"Discovery toolkit\"}]}},{\"method\":\"addSection\",\"value\":{\"kind\":\"newCardSection\",\"children\":[{\"method\":\"addWidget\",\"value\":{\"kind\":\"newTextParagraph\",\"children\":[{\"method\":\"setText\",\"value\":\"Review automation before applying changes.\"}]}}]}}]}",
    "{\"kind\":\"newCardBuilder\",\"children\":[{\"method\":\"setHeader\",\"value\":{\"kind\":\"newCardHeader\",\"children\":[{\"method\":\"setTitle\",\"value\":\"Discovery toolkit\"}]}},{\"method\":\"addSection\",\"value\":{\"kind\":\"newCardSection\",\"children\":[{\"method\":\"addWidget\",\"value\":{\"kind\":\"newTextParagraph\",\"children\":[{\"method\":\"setText\",\"value\":\"Review automation before applying changes.\"}]}}]}}]}"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}
function main() {
  console.log("Start: Editor add-ons and Workspace add-ons");
  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 section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 3: const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
Line 4: console.log(JSON.stringify(card));
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 5: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 6: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 7: console.log("Start: Editor add-ons and Workspace add-ons");
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 8: try { lessonAction(); console.log("Completed operation"); }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: 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 10: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "Start: Editor add-ons and Workspace add-ons",
    "{\"kind\":\"newCardBuilder\",\"children\":[{\"method\":\"setHeader\",\"value\":{\"kind\":\"newCardHeader\",\"children\":[{\"method\":\"setTitle\",\"value\":\"Discovery toolkit\"}]}},{\"method\":\"addSection\",\"value\":{\"kind\":\"newCardSection\",\"children\":[{\"method\":\"addWidget\",\"value\":{\"kind\":\"newTextParagraph\",\"children\":[{\"method\":\"setText\",\"value\":\"Review automation before applying changes.\"}]}}]}}]}",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: A card has a header and section with a text widget. The structural JSON is not an installed add-on. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Unrelated toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}

Graduated hints

Hint 1

Inspect the operation containing Unrelated toolkit. Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns Discovery toolkit. Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses Discovery toolkit where the broken source uses Unrelated toolkit. Explain why before applying it.

Reference solution

function main() {
  const section = CardService.newCardSection().addWidget(CardService.newTextParagraph().setText("Review automation before applying changes."));
  const card = CardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle("Discovery toolkit")).addSection(section).build();
  console.log(JSON.stringify(card));
}

Explain and reflect

Which operation proves the intended result in editor add-ons and workspace add-ons? Which wrong input would expose a weakness, and what would remain unchanged?

Adapt the calculation or validation 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 logs 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: AI-assisted coding with verification