DiscoveryVIP / Apps Script AcademyHelp

30. Automated spreadsheet reports

Module 6 · 20 minutes · Lesson 29; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use automated spreadsheet reports without changing the wrong data?

Predict

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

Understand

A report combines a stable input selection, local calculations and an explicit destination. Do not overwrite the source data with a summary. This script writes a new Report sheet and checks whether it already exists to support reruns. A new blank tab and an existing report require the same output shape but different creation paths.

Example 1: Working automation

The numeric total is written into a separate two-by-two report, leaving Sales intact.

function main() {
  const book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + row[1], 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}
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 book = SpreadsheetApp.getActiveSpreadsheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 4: const total = rows.reduce((sum, row) => sum + row[1], 0);
Combine the records into one accumulator with the stated initial value.
Line 5: const report = book.getSheetByName("Report") || book.insertSheet("Report");
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 6: report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": null,
  "resource": "sheets",
  "value": {
    "People": [
      [
        "Name",
        "Status"
      ],
      [
        "Alex",
        "Pending"
      ],
      [
        "Jordan",
        "Pending"
      ],
      [
        "Morgan",
        "Pending"
      ]
    ],
    "Sales": [
      [
        "Customer",
        "Amount",
        "Approved"
      ],
      [
        "Alex",
        120,
        true
      ],
      [
        "Jordan",
        80,
        false
      ],
      [
        "Morgan",
        200,
        true
      ]
    ],
    "Tasks": [
      [
        "Task",
        "Status"
      ],
      [
        "Review invoice",
        "Open"
      ],
      [
        "Publish report",
        "Complete"
      ]
    ],
    "Report": [
      [
        "Metric",
        "Value"
      ],
      [
        "Sales total",
        400
      ]
    ]
  }
}

Example 2: Investigate a reproducible failure

Predict the effect of sum + 1 and identify the first mismatch. This example is intentionally faulty.

function main() {
  const book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + 1, 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}
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 book = SpreadsheetApp.getActiveSpreadsheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 4: const total = rows.reduce((sum, row) => sum + 1, 0);
Combine the records into one accumulator with the stated initial value.
Line 5: const report = book.getSheetByName("Report") || book.insertSheet("Report");
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 6: report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [],
  "error": null,
  "resource": "sheets",
  "value": {
    "People": [
      [
        "Name",
        "Status"
      ],
      [
        "Alex",
        "Pending"
      ],
      [
        "Jordan",
        "Pending"
      ],
      [
        "Morgan",
        "Pending"
      ]
    ],
    "Sales": [
      [
        "Customer",
        "Amount",
        "Approved"
      ],
      [
        "Alex",
        120,
        true
      ],
      [
        "Jordan",
        80,
        false
      ],
      [
        "Morgan",
        200,
        true
      ]
    ],
    "Tasks": [
      [
        "Task",
        "Status"
      ],
      [
        "Review invoice",
        "Open"
      ],
      [
        "Publish report",
        "Complete"
      ]
    ],
    "Report": [
      [
        "Metric",
        "Value"
      ],
      [
        "Sales total",
        3
      ]
    ]
  }
}

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 book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + row[1], 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}
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 book = SpreadsheetApp.getActiveSpreadsheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 4: const total = rows.reduce((sum, row) => sum + row[1], 0);
Combine the records into one accumulator with the stated initial value.
Line 5: const report = book.getSheetByName("Report") || book.insertSheet("Report");
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 6: report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
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": [],
  "error": null,
  "resource": "sheets",
  "value": {
    "People": [
      [
        "Name",
        "Status"
      ],
      [
        "Alex",
        "Pending"
      ],
      [
        "Jordan",
        "Pending"
      ],
      [
        "Morgan",
        "Pending"
      ]
    ],
    "Sales": [
      [
        "Customer",
        "Amount",
        "Approved"
      ],
      [
        "Alex",
        120,
        true
      ],
      [
        "Jordan",
        80,
        false
      ],
      [
        "Morgan",
        200,
        true
      ]
    ],
    "Tasks": [
      [
        "Task",
        "Status"
      ],
      [
        "Review invoice",
        "Open"
      ],
      [
        "Publish report",
        "Complete"
      ]
    ],
    "Report": [
      [
        "Metric",
        "Value"
      ],
      [
        "Sales total",
        400
      ]
    ]
  }
}

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 book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + row[1], 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}
function main() {
  console.log("Start: Automated spreadsheet reports");
  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 book = SpreadsheetApp.getActiveSpreadsheet();
Resolve the current workbook. A real standalone project needs openById with a configured ID instead.
Line 3: const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 4: const total = rows.reduce((sum, row) => sum + row[1], 0);
Combine the records into one accumulator with the stated initial value.
Line 5: const report = book.getSheetByName("Report") || book.insertSheet("Report");
Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
Line 6: report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
Select a rectangular area. A1 letters name columns; row and numeric range coordinates start at one.
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: Automated spreadsheet reports");
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: Automated spreadsheet reports",
    "Completed operation"
  ],
  "error": null,
  "resource": "sheets",
  "value": {
    "People": [
      [
        "Name",
        "Status"
      ],
      [
        "Alex",
        "Pending"
      ],
      [
        "Jordan",
        "Pending"
      ],
      [
        "Morgan",
        "Pending"
      ]
    ],
    "Sales": [
      [
        "Customer",
        "Amount",
        "Approved"
      ],
      [
        "Alex",
        120,
        true
      ],
      [
        "Jordan",
        80,
        false
      ],
      [
        "Morgan",
        200,
        true
      ]
    ],
    "Tasks": [
      [
        "Task",
        "Status"
      ],
      [
        "Review invoice",
        "Open"
      ],
      [
        "Publish report",
        "Complete"
      ]
    ],
    "Report": [
      [
        "Metric",
        "Value"
      ],
      [
        "Sales total",
        400
      ]
    ]
  }
}

Build and test

Repair the supplied script so that: The numeric total is written into a separate two-by-two report, leaving Sales intact. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + 1, 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}

Graduated hints

Hint 1

Inspect the operation containing sum + 1. Compare it with the stated rule and the first mismatch.

Hint 2

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

Hint 3

The reference uses sum + row[1] where the broken source uses sum + 1. Explain why before applying it.

Reference solution

function main() {
  const book = SpreadsheetApp.getActiveSpreadsheet();
  const rows = book.getSheetByName("Sales").getDataRange().getValues().slice(1);
  const total = rows.reduce((sum, row) => sum + row[1], 0);
  const report = book.getSheetByName("Report") || book.insertSheet("Report");
  report.getRange("A1:B2").setValues([["Metric", "Value"], ["Sales total", total]]);
}

Explain and reflect

Which operation proves the intended result in automated spreadsheet reports? Which wrong input would expose a weakness, and what would remain unchanged?

Adapt the input records and sheets 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 sheets 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: Google Docs document structure