17. Accessing a spreadsheet and its sheets
Module 4 · 20 minutes · Lesson 16; earlier service and JavaScript fundamentals
Open Interactive LessonDiscover
How can you use accessing a spreadsheet and its sheets without changing the wrong data?
- Explain accessing a spreadsheet and its sheets in your own words
- Trace the actual console result 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
getSheetByName accepts the exact tab name and returns a Sheet or null. Check null before invoking another method. An active spreadsheet exists only in suitable contexts; standalone scripts should open a configured ID. IDs are opaque identifiers, not the visible name. Fictional IDs work only in the local adapter.
Example 1: Working automation
Case and spelling matter. The explicit guard gives a useful message instead of a null-property error.
function main() {
const book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("Sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}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 sheet = book.getSheetByName("Sales");
- Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
- Line 4: if (!sheet) throw new Error("Sales sheet missing");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log(sheet.getName());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Sales"
],
"error": null,
"resource": "logs",
"value": null
}Example 2: Investigate a reproducible failure
Predict the effect of "sales" and identify the first mismatch. This example is intentionally faulty.
function main() {
const book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}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 sheet = book.getSheetByName("sales");
- Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
- Line 4: if (!sheet) throw new Error("Sales sheet missing");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log(sheet.getName());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [],
"error": "Sales sheet missing",
"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 book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("Sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}
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 sheet = book.getSheetByName("Sales");
- Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
- Line 4: if (!sheet) throw new Error("Sales sheet missing");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log(sheet.getName());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 7: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- 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: lessonAction();
- Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
- Line 10: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Sales",
"Sales"
],
"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 book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("Sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}
function main() {
console.log("Start: Accessing a spreadsheet and its sheets");
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 sheet = book.getSheetByName("Sales");
- Resolve the exact sheet name. A missing sheet returns null and must be handled before chaining methods.
- Line 4: if (!sheet) throw new Error("Sales sheet missing");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 5: console.log(sheet.getName());
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 6: }
- Close the current block. Indentation makes scope and the function boundary visible.
- Line 7: function main() {
- Define a named block of instructions. Run Script calls main; helpers run only when called.
- Line 8: console.log("Start: Accessing a spreadsheet and its sheets");
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 9: try { lessonAction(); console.log("Completed operation"); }
- Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
- Line 10: 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 11: }
- Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
"logs": [
"Start: Accessing a spreadsheet and its sheets",
"Sales",
"Completed operation"
],
"error": null,
"resource": "logs",
"value": null
}Build and test
Repair the supplied script so that: Case and spelling matter. The explicit guard gives a useful message instead of a null-property error. Preserve other source data. Checks compare observable output and the named resource, not exact source text.
function main() {
const book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}Graduated hints
Hint 1
Inspect the operation containing "sales". Compare it with the stated rule and the first mismatch.
Hint 2
The repair concerns "Sales". Change only the relevant argument, operator or method; rerun with fresh input.
Hint 3
The reference uses "Sales" where the broken source uses "sales". Explain why before applying it.
Reference solution
function main() {
const book = SpreadsheetApp.getActiveSpreadsheet();
const sheet = book.getSheetByName("Sales");
if (!sheet) throw new Error("Sales sheet missing");
console.log(sheet.getName());
}Explain and reflect
Which operation proves the intended result in accessing a spreadsheet and its sheets? 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.