DiscoveryVIP / Apps Script AcademyHelp

37. Finding files and folders

Module 8 · 20 minutes · Lesson 36; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use finding files and folders without changing the wrong data?

Predict

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

Understand

Name searches return iterators because multiple files may share a name. Call hasNext before next and decide how to handle zero or several matches. Do not assume a unique file based only on its title. For production shared-drive operations consult the Advanced Drive service when DriveApp is insufficient.

Example 1: Working automation

The iterator yields the one matching fictional file; an absent name yields zero matches without next being called.

function main() {
  const files = DriveApp.getFilesByName("Brief.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}
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 files = DriveApp.getFilesByName("Brief.txt");
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: let count = 0;
Initialize a local value that can be updated as the calculation or loop proceeds.
Line 4: while (files.hasNext()) {
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 5: console.log(files.next().getId());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 6: count++;
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: console.log(count);
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "brief",
    "1"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of "Missing.txt" and identify the first mismatch. This example is intentionally faulty.

function main() {
  const files = DriveApp.getFilesByName("Missing.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}
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 files = DriveApp.getFilesByName("Missing.txt");
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: let count = 0;
Initialize a local value that can be updated as the calculation or loop proceeds.
Line 4: while (files.hasNext()) {
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 5: console.log(files.next().getId());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 6: count++;
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: console.log(count);
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "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() {
  const files = DriveApp.getFilesByName("Brief.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}
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 files = DriveApp.getFilesByName("Brief.txt");
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: let count = 0;
Initialize a local value that can be updated as the calculation or loop proceeds.
Line 4: while (files.hasNext()) {
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 5: console.log(files.next().getId());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 6: count++;
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: console.log(count);
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 10: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 11: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 12: lessonAction();
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 13: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "brief",
    "1",
    "brief",
    "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() {
  const files = DriveApp.getFilesByName("Brief.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}
function main() {
  console.log("Start: Finding files and folders");
  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 files = DriveApp.getFilesByName("Brief.txt");
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: let count = 0;
Initialize a local value that can be updated as the calculation or loop proceeds.
Line 4: while (files.hasNext()) {
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 5: console.log(files.next().getId());
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 6: count++;
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 7: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 8: console.log(count);
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 9: }
Close the current block. Indentation makes scope and the function boundary visible.
Line 10: function main() {
Define a named block of instructions. Run Script calls main; helpers run only when called.
Line 11: console.log("Start: Finding files and folders");
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 12: try { lessonAction(); console.log("Completed operation"); }
Record diagnostic evidence. A log does not grant permissions or prove a later side effect succeeded.
Line 13: 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 14: }
Close the current block. Indentation makes scope and the function boundary visible.
Exact expected output and resource
{
  "logs": [
    "Start: Finding files and folders",
    "brief",
    "1",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: The iterator yields the one matching fictional file; an absent name yields zero matches without next being called. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const files = DriveApp.getFilesByName("Missing.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}

Graduated hints

Hint 1

Inspect the operation containing "Missing.txt". Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns "Brief.txt". Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses "Brief.txt" where the broken source uses "Missing.txt". Explain why before applying it.

Reference solution

function main() {
  const files = DriveApp.getFilesByName("Brief.txt");
  let count = 0;
  while (files.hasNext()) {
    console.log(files.next().getId());
    count++;
  }
  console.log(count);
}

Explain and reflect

Which operation proves the intended result in finding files and folders? 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: Creating, copying, renaming and moving files