78. Retrieving data with UrlFetchApp
Module 16 · 20 minutes · Lesson 77; earlier service and JavaScript fundamentals
Open Interactive LessonDiscover
How can you use retrieving data with urlfetchapp without changing the wrong data?
- Explain retrieving data with urlfetchapp 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
Parse content only after checking the HTTP status. muteHttpExceptions allows inspecting error responses instead of throwing immediately; it does not make them successful. Avoid logging credentials in headers or query strings. A local fixture’s timing is not a measurement of a real API. Keep real endpoint configuration outside lesson source.
Example 1: Working automation
The status guard accepts the known fixture before parsing its category. Inverting it rejects a good response.
function main() {
const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 4: const data = JSON.parse(response.getContentText());
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 5: console.log(data.category);
- 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": [
"support"
],
"error": null,
"resource": "logs",
"value": null
}Example 2: Investigate a reproducible failure
Predict the effect of === 200 and identify the first mismatch. This example is intentionally faulty.
function main() {
const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() === 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: if (response.getResponseCode() === 200) throw new Error("Unexpected HTTP status");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 4: const data = JSON.parse(response.getContentText());
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 5: console.log(data.category);
- 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": "Unexpected HTTP status",
"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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}
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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 4: const data = JSON.parse(response.getContentText());
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 5: console.log(data.category);
- 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": [
"support",
"support"
],
"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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}
function main() {
console.log("Start: Retrieving data with UrlFetchApp");
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 response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 3: if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
- Reject the current operation with an explicit error instead of silently continuing on invalid assumptions.
- Line 4: const data = JSON.parse(response.getContentText());
- Initialize a local binding. const prevents reassignment of that binding, but does not freeze a referenced object.
- Line 5: console.log(data.category);
- 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: Retrieving data with UrlFetchApp");
- 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: Retrieving data with UrlFetchApp",
"support",
"Completed operation"
],
"error": null,
"resource": "logs",
"value": null
}Build and test
Repair the supplied script so that: The status guard accepts the known fixture before parsing its category. Inverting it rejects a good response. Preserve other source data. Checks compare observable output and the named resource, not exact source text.
function main() {
const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() === 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}Graduated hints
Hint 1
Inspect the operation containing === 200. Compare it with the stated rule and the first mismatch.
Hint 2
The repair concerns !== 200. Change only the relevant argument, operator or method; rerun with fresh input.
Hint 3
The reference uses !== 200 where the broken source uses === 200. Explain why before applying it.
Reference solution
function main() {
const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
if (response.getResponseCode() !== 200) throw new Error("Unexpected HTTP status");
const data = JSON.parse(response.getContentText());
console.log(data.category);
}Explain and reflect
Which operation proves the intended result in retrieving data with urlfetchapp? 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.