DiscoveryVIP / Apps Script AcademyHelp

76. APIs and HTTP requests

Module 16 · 20 minutes · Lesson 75; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use apis and http requests without changing the wrong data?

Predict

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

Understand

An HTTP request has a URL, method, headers and optional body. A response has a status and content that must be interpreted. UrlFetchApp executes on the server and requires external-request authorization. The local adapter records the request but returns an authored response, never external data. The request inspector makes this boundary visible.

Example 1: Working automation

The documented method retrieves a local 200 fixture status; the plural method is invented.

function main() {
  const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
  console.log(response.getResponseCode());
  console.log(response.getContentText());
}
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: console.log(response.getResponseCode());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 4: console.log(response.getContentText());
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": [
    "200",
    "{\"category\":\"support\",\"summary\":\"Synthetic response\"}"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of getResponseCodes() and identify the first mismatch. This example is intentionally faulty.

function main() {
  const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
  console.log(response.getResponseCodes());
  console.log(response.getContentText());
}
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: console.log(response.getResponseCodes());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 4: console.log(response.getContentText());
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": [],
  "error": "response.getResponseCodes is not a function",
  "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});
  console.log(response.getResponseCode());
  console.log(response.getContentText());
}
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: console.log(response.getResponseCode());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 4: console.log(response.getContentText());
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": [
    "200",
    "{\"category\":\"support\",\"summary\":\"Synthetic response\"}",
    "200",
    "{\"category\":\"support\",\"summary\":\"Synthetic response\"}"
  ],
  "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});
  console.log(response.getResponseCode());
  console.log(response.getContentText());
}
function main() {
  console.log("Start: APIs and HTTP requests");
  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: console.log(response.getResponseCode());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 4: console.log(response.getContentText());
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: APIs and HTTP requests");
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: APIs and HTTP requests",
    "200",
    "{\"category\":\"support\",\"summary\":\"Synthetic response\"}",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: The documented method retrieves a local 200 fixture status; the plural method is invented. 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});
  console.log(response.getResponseCodes());
  console.log(response.getContentText());
}

Graduated hints

Hint 1

Inspect the operation containing getResponseCodes(). Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns getResponseCode(). Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses getResponseCode() where the broken source uses getResponseCodes(). Explain why before applying it.

Reference solution

function main() {
  const response = UrlFetchApp.fetch("https://example.com/fixture", {muteHttpExceptions: true});
  console.log(response.getResponseCode());
  console.log(response.getContentText());
}

Explain and reflect

Which operation proves the intended result in apis and http requests? 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: JSON data