DiscoveryVIP / Apps Script AcademyHelp

74. Asynchronous google.script.run callbacks

Module 15 · 20 minutes · Lesson 73; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use asynchronous google.script.run callbacks without changing the wrong data?

Predict

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

Understand

A success handler receives a server result; a failure handler receives an error. Do not read a result synchronously from google.script.run. Responses can arrive out of request order, so disable dependent actions or use request IDs. Dates and functions are not permitted bridge parameters; serialize dates deliberately. This server fixture is used by the working studio bridge.

Example 1: Working automation

The serialized object reports the two total tasks and the one open task.

function main() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: console.log(getSummary());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 3: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 4: function getSummary() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 5: const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 6: return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
End this function and pass its value to the caller; logging alone does not return a result.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"count\":2,\"open\":1}"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of row[1] === "Closed" and identify the first mismatch. This example is intentionally faulty.

function main() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Closed").length};
}
Important line explanations
Line 1: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 2: console.log(getSummary());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 3: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 4: function getSummary() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 5: const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 6: return {count: rows.length, open: rows.filter(row => row[1] === "Closed").length};
End this function and pass its value to the caller; logging alone does not return a result.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"count\":2,\"open\":0}"
  ],
  "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() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
}
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: console.log(getSummary());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 3: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 4: function getSummary() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 5: const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 6: return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
End this function and pass its value to the caller; logging alone does not return a result.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 9: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 10: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 11: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "{\"count\":2,\"open\":1}",
    "{\"count\":2,\"open\":1}"
  ],
  "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() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
}
function main() {
  console.log("Start: Asynchronous google.script.run callbacks");
  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: console.log(getSummary());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 3: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 4: function getSummary() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 5: const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 6: return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
End this function and pass its value to the caller; logging alone does not return a result.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 9: console.log("Start: Asynchronous google.script.run callbacks");
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 10: try { lessonAction(); console.log("Completed operation"); }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 11: 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 12: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "Start: Asynchronous google.script.run callbacks",
    "{\"count\":2,\"open\":1}",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: The serialized object reports the two total tasks and the one open task. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Closed").length};
}

Graduated hints

Hint 1

Inspect the operation containing row[1] === "Closed". Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns row[1] === "Open". Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses row[1] === "Open" where the broken source uses row[1] === "Closed". Explain why before applying it.

Reference solution

function main() {
  console.log(getSummary());
}
function getSummary() {
  const rows = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Tasks").getDataRange().getValues().slice(1);
  return {count: rows.length, open: rows.filter(row => row[1] === "Open").length};
}

Explain and reflect

Which operation proves the intended result in asynchronous google.script.run callbacks? 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: Deploying and configuring access