DiscoveryVIP / Apps Script AcademyHelp

52. Reading and searching events

Module 11 · 20 minutes · Lesson 51; earlier service and JavaScript fundamentals

Open Interactive Lesson

Discover

How can you use reading and searching events without changing the wrong data?

Predict

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

Understand

getEvents selects events overlapping a time interval. Date objects represent instants, while display time depends on a time zone. An empty result is normal and should not be treated as permission to overwrite another calendar. This example creates a sample event, then queries the relevant day to make the test reproducible.

Example 1: Working automation

The broad interval overlaps the event; a window ending before the event starts does not.

function main() {
  const calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
}
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 calendar = CalendarApp.getDefaultCalendar();
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 4: console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
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": [
    "[\"Review\"]"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Example 2: Investigate a reproducible failure

Predict the effect of new Date("2026-12-01T01:00:00Z") and identify the first mismatch. This example is intentionally faulty.

function main() {
  const calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-01T01:00:00Z")).map(event => event.getTitle()));
}
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 calendar = CalendarApp.getDefaultCalendar();
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 4: console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-01T01:00:00Z")).map(event => event.getTitle()));
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": 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 calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
}
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 calendar = CalendarApp.getDefaultCalendar();
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 4: console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
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": [
    "[\"Review\"]",
    "[\"Review\",\"Review\"]"
  ],
  "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 calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
}
function main() {
  console.log("Start: Reading and searching events");
  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 calendar = CalendarApp.getDefaultCalendar();
Call the named Workspace service. Locally this invokes a documented adapter; in Google it may require authorization and create persistent changes.
Line 3: calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
Follow this operation using the surrounding named values. Compare the actual recorded state with the lesson’s specific explanation below.
Line 4: console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
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: Reading and searching events");
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: Reading and searching events",
    "[\"Review\"]",
    "Completed operation"
  ],
  "error": null,
  "resource": "logs",
  "value": null
}

Build and test

Repair the supplied script so that: The broad interval overlaps the event; a window ending before the event starts does not. Preserve other source data. Checks compare observable output and the named resource, not exact source text.

function main() {
  const calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-01T01:00:00Z")).map(event => event.getTitle()));
}

Graduated hints

Hint 1

Inspect the operation containing new Date("2026-12-01T01:00:00Z"). Compare it with the stated rule and the first mismatch.

Hint 2

The repair concerns new Date("2026-12-02T00:00:00Z"). Change only the relevant argument, operator or method; rerun with fresh input.

Hint 3

The reference uses new Date("2026-12-02T00:00:00Z") where the broken source uses new Date("2026-12-01T01:00:00Z"). Explain why before applying it.

Reference solution

function main() {
  const calendar = CalendarApp.getDefaultCalendar();
  calendar.createEvent("Review", new Date("2026-12-01T14:00:00Z"), new Date("2026-12-01T15:00:00Z"));
  console.log(calendar.getEvents(new Date("2026-12-01T00:00:00Z"), new Date("2026-12-02T00:00:00Z")).map(event => event.getTitle()));
}

Explain and reflect

Which operation proves the intended result in reading and searching events? 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 and modifying events safely