Stay organized with collections Save and categorize content based on your preferences.
CalendarAppAllows a script to read and update the user's Google Calendar. This class provides direct access to the user's default calendar, as well as the ability to retrieve additional calendars that the user owns or is subscribed to.
Properties Property Type DescriptionColor
Color
An enum representing the named colors available in the Calendar service. EventColor
EventColor
An enum representing the named event colors available in the Calendar service. EventTransparency
EventTransparency
The EventTransparency
enumeration. EventType
EventType
The EventType
enumeration. GuestStatus
GuestStatus
An enum representing the statuses a guest can have for an event. Month
Month
An enum representing the months of the year. Visibility
Visibility
An enum representing the visibility of an event. Weekday
Weekday
An enum representing the days of the week. Methods Method Return type Brief description createAllDayEvent(title, date)
CalendarEvent
Creates a new all-day event. createAllDayEvent(title, startDate, endDate)
CalendarEvent
Creates a new all-day event that can span multiple days. createAllDayEvent(title, startDate, endDate, options)
CalendarEvent
Creates a new all-day event that can span multiple days. createAllDayEvent(title, date, options)
CalendarEvent
Creates a new all-day event. createAllDayEventSeries(title, startDate, recurrence)
CalendarEventSeries
Creates a new all-day event series. createAllDayEventSeries(title, startDate, recurrence, options)
CalendarEventSeries
Creates a new all-day event series. createCalendar(name)
Calendar
Creates a new calendar, owned by the user. createCalendar(name, options)
Calendar
Creates a new calendar, owned by the user. createEvent(title, startTime, endTime)
CalendarEvent
Creates a new event. createEvent(title, startTime, endTime, options)
CalendarEvent
Creates a new event. createEventFromDescription(description)
CalendarEvent
Creates an event from a free-form description. createEventSeries(title, startTime, endTime, recurrence)
CalendarEventSeries
Creates a new event series. createEventSeries(title, startTime, endTime, recurrence, options)
CalendarEventSeries
Creates a new event series. getAllCalendars()
Calendar[]
Gets all calendars that the user owns or is subscribed to. getAllOwnedCalendars()
Calendar[]
Gets all calendars that the user owns. getCalendarById(id)
Calendar
Gets the calendar with the given ID. getCalendarsByName(name)
Calendar[]
Gets all calendars with a given name that the user owns or is subscribed to. getColor()
String
Gets the color of the calendar. getDefaultCalendar()
Calendar
Gets the user's default calendar. getDescription()
String
Gets the description of the calendar. getEventById(iCalId)
CalendarEvent
Gets the event with the given ID. getEventSeriesById(iCalId)
CalendarEventSeries
Gets the event series with the given ID. getEvents(startTime, endTime)
CalendarEvent[]
Gets all events that occur within a given time range. getEvents(startTime, endTime, options)
CalendarEvent[]
Gets all events that occur within a given time range and meet the specified criteria. getEventsForDay(date)
CalendarEvent[]
Gets all events that occur on a given day. getEventsForDay(date, options)
CalendarEvent[]
Gets all events that occur on a given day and meet specified criteria. getId()
String
Gets the ID of the calendar. getName()
String
Gets the name of the calendar. getOwnedCalendarById(id)
Calendar
Gets the calendar with the given ID, if the user owns it. getOwnedCalendarsByName(name)
Calendar[]
Gets all calendars with a given name that the user owns. getTimeZone()
String
Gets the time zone of the calendar. isHidden()
Boolean
Determines whether the calendar is hidden in the user interface. isMyPrimaryCalendar()
Boolean
Determines whether the calendar is the primary calendar for the effective user. isOwnedByMe()
Boolean
Determines whether the calendar is owned by you. isSelected()
Boolean
Determines whether the calendar's events are displayed in the user interface. newRecurrence()
EventRecurrence
Creates a new recurrence object, which can be used to create rules for event recurrence. setColor(color)
Calendar
Sets the color of the calendar. setDescription(description)
Calendar
Sets the description of a calendar. setHidden(hidden)
Calendar
Sets whether the calendar is visible in the user interface. setName(name)
Calendar
Sets the name of the calendar. setSelected(selected)
Calendar
Sets whether the calendar's events are displayed in the user interface. setTimeZone(timeZone)
Calendar
Sets the time zone of the calendar. subscribeToCalendar(id)
Calendar
Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe. subscribeToCalendar(id, options)
Calendar
Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe. Detailed documentation createAllDayEvent(title, date)
Creates a new all-day event.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
The title of the event. date
Date
The date of the event (only the day is used; the time is ignored). Return
CalendarEvent
— The created event.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate)
Creates a new all-day event that can span multiple days.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
The title of the event. startDate
Date
The date when the event starts (only the day is used; the time is ignored). endDate
Date
The date when the event ends (only the day is used; the time is ignored). The end date is exclusive. Return
CalendarEvent
— The created event.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createAllDayEvent(title, startDate, endDate, options)
Creates a new all-day event that can span multiple days.
// Creates an all-day event for the Woodstock festival (August 15th to 17th) and // logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Woodstock Festival', new Date('August 15, 1969'), new Date('August 18, 1969'), {location: 'Bethel, White Lake, New York, U.S.', sendInvites: true}, ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
The title of the event. startDate
Date
The date when the event starts (only the day is used; the time is ignored). endDate
Date
The date when the event ends (only the day is used; the time is ignored). The end date is exclusive. options
Object
A JavaScript object that specifies advanced parameters, as listed below. Advanced parameters Name Type Description description
String
The description of the event. location
String
The location of the event. guests
String
A comma-separated list of email addresses that should be added as guests. sendInvites
Boolean
Whether to send invitation emails (default: false
). Return
CalendarEvent
— The created event.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createAllDayEvent(title, date, options)
Creates a new all-day event.
// Creates an all-day event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createAllDayEvent( 'Apollo 11 Landing', new Date('July 20, 1969'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
The title of the event. date
Date
The date of the event (only the day is used; the time is ignored). options
Object
A JavaScript object that specifies advanced parameters, as listed below. Advanced parameters Name Type Description description
String
The description of the event. location
String
The location of the event. guests
String
A comma-separated list of email addresses that should be added as guests. sendInvites
Boolean
Whether to send invitation emails (default: false
). Return
CalendarEvent
— The created event.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence)
Creates a new all-day event series.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);Parameters Name Type Description
title
String
the title of the events in the series startDate
Date
the date of the first event in the series (only the day is used; the time is ignored) recurrence
EventRecurrence
the recurrence settings of the event series Return
CalendarEventSeries
— the created event series
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createAllDayEventSeries(title, startDate, recurrence, options)
Creates a new all-day event series.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')), {guests: 'everyone@example.com'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);Parameters Name Type Description
title
String
the title of the events in the series startDate
Date
the date of the first event in the series (only the day is used; the time is ignored) recurrence
EventRecurrence
the recurrence settings of the event series options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description description
String
the description of the events in the series location
String
the location of the events in the series guests
String
a comma-separated list of email addresses that should be added as guests to the events in the series sendInvites
Boolean
whether to send invitation emails (default: false
) Return
CalendarEventSeries
— the created event series
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createCalendar(name)
Creates a new calendar, owned by the user.
// Creates a new calendar named "Travel Plans". const calendar = CalendarApp.createCalendar('Travel Plans'); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );Parameters Name Type Description
name
String
the name of the new calendar Return
Calendar
— the newly created calendar
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createCalendar(name, options)
Creates a new calendar, owned by the user.
// Creates a new calendar named "Travel Plans" with a description and color. const calendar = CalendarApp.createCalendar('Travel Plans', { description: 'A calendar to plan my travel schedule.', color: CalendarApp.Color.BLUE, }); Logger.log( 'Created the calendar "%s", with the ID "%s".', calendar.getName(), calendar.getId(), );Parameters Name Type Description
name
String
the name of the new calendar options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description location
String
the calendar's location description
String
the calendar's description timeZone
String
the time zone to set the calendar to, specified in "long" format (e.g., "America/New_York", as listed by Joda.org) color
String
a hexadecimal color string ("#rrggbb") or a value from CalendarApp.Colors
hidden
Boolean
whether the calendar is hidden in the user interface (default: false
) selected
Boolean
whether the calendar's events are displayed in the user interface (default: true
) Return
Calendar
— the newly created calendar
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime)
Creates a new event.
If no time zone is specified, the time values are interpreted in the context of the script's time zone, which may be different than the calendar's time zone.
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 21, 1969 21:00:00 UTC'), ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
the title of the event startTime
Date
the date and time when the event starts endTime
Date
the date and time when the event ends Return
CalendarEvent
— the created event
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createEvent(title, startTime, endTime, options)
Creates a new event.
If no time zone is specified, the time values are interpreted in the context of the script's time zone, which may be different than the calendar's time zone.
// Creates an event for the moon landing and logs the ID. const event = CalendarApp.getDefaultCalendar().createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:00:00 UTC'), new Date('July 20, 1969 21:00:00 UTC'), {location: 'The Moon'}, ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
title
String
the title of the event startTime
Date
the date and time when the event starts endTime
Date
the date and time when the event ends options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description description
String
the description of the event location
String
the location of the event guests
String
a comma-separated list of email addresses that should be added as guests sendInvites
Boolean
whether to send invitation emails (default: false
) Return
CalendarEvent
— the created event
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createEventFromDescription(description)
Creates an event from a free-form description.
The description should use the same format as the UI's "Quick Add" feature.
// Creates a new event and logs its ID. const event = CalendarApp.getDefaultCalendar().createEventFromDescription( 'Lunch with Mary, Friday at 1PM', ); Logger.log(`Event ID: ${event.getId()}`);Parameters Name Type Description
description
String
a free-form description of the event Return
CalendarEvent
— the created event
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence)
Creates a new event series.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);Parameters Name Type Description
title
String
the title of the events in the series startTime
Date
the date and time when the first event in the series starts endTime
Date
the date and time when the first event in the series ends recurrence
EventRecurrence
the recurrence settings of the event series Return
CalendarEventSeries
— the created event series
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
createEventSeries(title, startTime, endTime, recurrence, options)
Creates a new event series.
// Creates an event series for a team meeting, taking place every Tuesday and // Thursday in 2013. const eventSeries = CalendarApp.getDefaultCalendar().createEventSeries( 'Team Meeting', new Date('January 1, 2013 03:00:00 PM EST'), new Date('January 1, 2013 04:00:00 PM EST'), CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekdays( [CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY]) .until(new Date('January 1, 2014')), {location: 'Conference Room'}, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);Parameters Name Type Description
title
String
the title of the events in the series startTime
Date
the date and time when the first event in the series starts endTime
Date
the date and time when the first event in the series ends recurrence
EventRecurrence
the recurrence settings of the event series options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description description
String
the description of the events in the series location
String
the location of the events in the series guests
String
a comma-separated list of email addresses that should be added as guests to the events in the series sendInvites
Boolean
whether to send invitation emails (default: false
) Return
CalendarEventSeries
— the created event series
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
getAllCalendars()
Gets all calendars that the user owns or is subscribed to.
// Determines how many calendars the user can access. const calendars = CalendarApp.getAllCalendars(); Logger.log( 'This user owns or is subscribed to %s calendars.', calendars.length, );Return
Calendar[]
— all calendars that the user can access
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getAllOwnedCalendars()
Gets all calendars that the user owns.
// Determines how many calendars the user owns. const calendars = CalendarApp.getAllOwnedCalendars(); Logger.log('This user owns %s calendars.', calendars.length);Return
Calendar[]
— all calendars that the user owns
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getCalendarById(id)
Gets the calendar with the given ID.
// Gets the public calendar "US Holidays" by ID. const calendar = CalendarApp.getCalendarById( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());Parameters Name Type Description
id
String
the calendar ID Return
Calendar
— the calendar with the given ID, or null
if the calendar does not exist, if the user cannot access it, or if the user is not subscribed to the calendar
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getCalendarsByName(name)
Gets all calendars with a given name that the user owns or is subscribed to. Names are not case-sensitive.
// Gets the public calendar named "US Holidays". const calendars = CalendarApp.getCalendarsByName('US Holidays'); Logger.log('Found %s matching calendars.', calendars.length);Parameters Name Type Description
name
String
the calendar name Return
Calendar[]
— all calendars with this name that the user can access
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getColor()
Gets the color of the calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the color of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getColor() instead. const calendarColor = calendar.getColor(); console.log(calendarColor);Return
String
— A hexadecimal color string ("#rrggbb").
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getDefaultCalendar()
Gets the user's default calendar.
// Determines the time zone of the user's default calendar. const calendar = CalendarApp.getDefaultCalendar(); Logger.log( 'My default calendar is set to the time zone "%s".', calendar.getTimeZone(), );Return
Calendar
— the user's default calendar
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getDescription()
Gets the description of the calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the description of the calendar to 'Test description.' calendar.setDescription('Test description'); // Gets the description of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getDescription() instead. const description = calendar.getDescription(); console.log(description);Return
String
— The description of this calendar.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEventById(iCalId)
Gets the event with the given ID. If the series belongs to a calendar other than the default calendar, this method must be called from that calendar. Calling getEventById(iCalId)
only returns an event in the default calendar.
Multiple events may have the same ID if they are part of an event series. In this case this method returns only the first event from that series.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event for the moon landing. const event = calendar.createEvent( 'Apollo 11 Landing', new Date('July 20, 1969 20:05:00 UTC'), new Date('July 20, 1969 20:17:00 UTC'), ); // Gets the calendar event ID and logs it to the console. const iCalId = event.getId(); console.log(iCalId); // Gets the event by its ID and logs the title of the event to the console. // For the default calendar, you can use CalendarApp.getEventById(iCalId) // instead. const myEvent = calendar.getEventById(iCalId); console.log(myEvent.getTitle());Parameters Name Type Description
iCalId
String
ID of the event. Return
CalendarEvent
— The event with the given ID, or null
if the event doesn't exist or the user cannot access it.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEventSeriesById(iCalId)
Gets the event series with the given ID. If the ID given is for a single CalendarEvent
, then a CalendarEventSeries
is returned with a single event in the series. Note that if the event series belongs to a calendar other than the default calendar, this method must be called from that CalendarApp
; calling getEventSeriesById(iCalId)
directly only returns an event series that exists in the default calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Creates an event series for a daily team meeting from 1 PM to 2 PM. // The series adds the daily event from January 1, 2023 through December 31, // 2023. const eventSeries = calendar.createEventSeries( 'Team meeting', new Date('Jan 1, 2023 13:00:00'), new Date('Jan 1, 2023 14:00:00'), CalendarApp.newRecurrence().addDailyRule().until(new Date('Jan 1, 2024')), ); // Gets the ID of the event series. const iCalId = eventSeries.getId(); // Gets the event series by its ID and logs the series title to the console. // For the default calendar, you can use CalendarApp.getEventSeriesById(iCalId) // instead. console.log(calendar.getEventSeriesById(iCalId).getTitle());Parameters Name Type Description
iCalId
String
ID of the event series. Return
CalendarEventSeries
— The series with the given ID, or null
if the series doesn't exist or the user cannot access it.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEvents(startTime, endTime)
Gets all events that occur within a given time range.
This method returns events that start during the given time range, end during the time range, or encompass the time range. If no time zone is specified, the time values are interpreted in the context of the script's time zone, which may be different from the calendar's time zone.
// Determines how many events are happening in the next two hours. const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents(now, twoHoursFromNow); Logger.log(`Number of events: ${events.length}`);Parameters Name Type Description
startTime
Date
the start of the time range endTime
Date
the end of the time range, non-inclusive Return
CalendarEvent[]
— the events that occur within the time range
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEvents(startTime, endTime, options)
Gets all events that occur within a given time range and meet the specified criteria.
This method returns events that start during the given time range, ends during the time range, or encompasses the time range. If no time zone is specified, the time values are interpreted in the context of the script's time zone, which may be different from the calendar's time zone.
Be aware that filtering on author
, search
, or statusFilters
takes place after applying start
and max
. This means that the number of events returned may be less than max
, even though additional events meet the criteria.
// Determines how many events are happening in the next two hours that contain // the term "meeting". const now = new Date(); const twoHoursFromNow = new Date(now.getTime() + 2 * 60 * 60 * 1000); const events = CalendarApp.getDefaultCalendar().getEvents( now, twoHoursFromNow, {search: 'meeting'}, ); Logger.log(`Number of events: ${events.length}`);Parameters Name Type Description
startTime
Date
the start of the time range endTime
Date
the end of the time range, non-inclusive options
Object
a JavaScript object that specifies advanced parameters, as listed below Advanced parameters Name Type Description start
Integer
the index of the first event to return max
Integer
the maximum number of events to return author
String
an email address used to filter results by the event creator search
String
a full-text search query used to filter results statusFilters[]
GuestStatus
an array of statuses used to filter results Return
CalendarEvent[]
— the events that take place within the time range and match the criteria
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEventsForDay(date)
Gets all events that occur on a given day.
This method returns events if they start during the given day, end during the day, or encompass the day.
Note that only the date portion of the Date object is used, and the time portion is ignored. The date is interpreted as midnight that day to midnight the next day in the calendar's time zone.
// Determines how many events are happening today. const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today); Logger.log(`Number of events: ${events.length}`);Parameters Name Type Description
date
Date
the date to retrieve events for (only the day is used; the time is ignored) Return
CalendarEvent[]
— the events that occur on the given date
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getEventsForDay(date, options)
Gets all events that occur on a given day and meet specified criteria.
This method returns events if they start during the given day, end during the day, or encompass the day.
Note that only the date portion of the Date object is used, and the time portion is ignored. The date is interpreted as midnight that day to midnight the next day in the calendar's time zone.
Be aware that filtering on author
, search
, or statusFilters
takes place after applying start
and max
. This means that the number of events returned may be less than max
, even though additional events meet the criteria.
// Determines how many events are happening today and contain the term // "meeting". const today = new Date(); const events = CalendarApp.getDefaultCalendar().getEventsForDay(today, { search: 'meeting', }); Logger.log(`Number of events: ${events.length}`);Parameters Name Type Description
date
Date
the date to retrieve events for (only the day is used; the time is ignored) options
Object
advanced filtering options Advanced parameters Name Type Description start
Integer
the index of the first event to return max
Integer
the maximum number of events to return author
String
an email address used to filter results by the event creator search
String
a full-text search query used to filter results statusFilters[]
GuestStatus
an array of statuses used to filter results Return
CalendarEvent[]
— the events that occur on the given date and match the criteria
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getId()
Gets the ID of the calendar. The ID for a user's default calendar is their email address.
// Opens the calendar by its ID. // To get the user's default calendar, use CalendarApp.getDefaultCalendar(). // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the ID of the calendar and logs it to the console. const calendarId = calendar.getId(); console.log(calendarId);Return
String
— The ID of the calendar.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getName()
Gets the name of the calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the name of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getName() instead. const calendarName = calendar.getName(); console.log(calendarName);Return
String
— This calendar's name.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getOwnedCalendarById(id)
Gets the calendar with the given ID, if the user owns it.
To find a calendar ID, click the arrow next to the calendar's name in Google Calendar and select Calendar settings. The ID is shown near the bottom of the settings page.
// Gets a (non-existent) private calendar by ID. const calendar = CalendarApp.getOwnedCalendarById( '123456789@group.calendar.google.com', ); Logger.log('The calendar is named "%s".', calendar.getName());Parameters Name Type Description
id
String
the calendar id Return
Calendar
— the calendar with the given ID, or null
if the calendar does not exist or the user does not own it
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getOwnedCalendarsByName(name)
Gets all calendars with a given name that the user owns. Names are not case-sensitive.
// Gets a private calendar named "Travel Plans". const calendars = CalendarApp.getOwnedCalendarsByName('Travel Plans'); Logger.log('Found %s matching calendars.', calendars.length);Parameters Name Type Description
name
String
the calendar name Return
Calendar[]
— all calendars with this name that the user owns
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
getTimeZone()
Gets the time zone of the calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Gets the time zone of the calendar and logs it to the console. // For the default calendar, you can use CalendarApp.getTimeZone() instead. const timeZone = calendar.getTimeZone(); console.log(timeZone);Return
String
— The time zone, specified in "long" format (for example, "America/New_York", as listed by Joda.org).
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
isMyPrimaryCalendar()
Determines whether the calendar is the primary calendar for the effective user.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Determines whether the calendar is the default calendar for // the effective user and logs it to the console. // For the default calendar, you can use CalendarApp.isMyPrimaryCalendar() // instead. const isMyPrimaryCalendar = calendar.isMyPrimaryCalendar(); console.log(isMyPrimaryCalendar);Return
Boolean
— true
if the calendar is the default calendar for the effective user; false
if it isn't.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
isOwnedByMe()
Determines whether the calendar is owned by you.
// Gets a calendar by its ID. To get the user's default calendar, use // CalendarApp.getDefault() instead. // TODO(developer): Replace the ID with the calendar ID that you want to use. const calendar = CalendarApp.getCalendarById( 'abc123456@group.calendar.google.com', ); // Determines whether the calendar is owned by you and logs it. console.log(calendar.isOwnedByMe());Return
Boolean
— true
if the calendar is owned by you; false
if not.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
isSelected()
Determines whether the calendar's events are displayed in the user interface.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Determines whether the calendar's events are displayed in the user interface // and logs it. console.log(calendar.isSelected());Return
Boolean
— true
if the calendar's events are displayed in the user interface; false
if not
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
newRecurrence()
Creates a new recurrence object, which can be used to create rules for event recurrence.
// Creates an event series for a no-meetings day, taking place every Wednesday // in 2013. const recurrence = CalendarApp.newRecurrence() .addWeeklyRule() .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY) .until(new Date('January 1, 2014')); const eventSeries = CalendarApp.getDefaultCalendar().createAllDayEventSeries( 'No Meetings', new Date('January 2, 2013 03:00:00 PM EST'), recurrence, ); Logger.log(`Event Series ID: ${eventSeries.getId()}`);Return
EventRecurrence
— a new recurrence object with no rules set (behaves as a weekly recurrence)
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.googleapis.com/auth/calendar.readonly
https://www.google.com/calendar/feeds
setColor(color)
Sets the color of the calendar.
// Opens the calendar by its ID. // TODO(developer): Replace the ID with your own. const calendar = CalendarApp.getCalendarById('222larabrown@gmail.com'); // Sets the color of the calendar to pink using the Calendar Color enum. // For the default calendar, you can use CalendarApp.setColor() instead. calendar.setColor(CalendarApp.Color.PINK);Parameters Name Type Description
color
String
A CalendarApp.Color
or a hexadecimal color string ("#rrggbb"). Return
Calendar
— This calendar for chaining.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
setDescription(description)
Sets the description of a calendar.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the description of the calendar. // TODO(developer): Update the string with the description that you want to use. calendar.setDescription('Updated calendar description.');Parameters Name Type Description
description
String
the description of this calendar Return
Calendar
— this calendar for chaining
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
setName(name)
Sets the name of the calendar.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the name of the calendar. // TODO(developer): Update the string with the name that you want to use. calendar.setName('Example calendar name');Parameters Name Type Description
name
String
the new name Return
Calendar
— this calendar for chaining
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
setSelected(selected)
Sets whether the calendar's events are displayed in the user interface.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Selects the calendar so that its events are displayed in the user interface. // To unselect the calendar, set the parameter to false. calendar.setSelected(true);Parameters Name Type Description
selected
Boolean
true
to show the calendar's events in the user interface; false
to hide them Return
Calendar
— this calendar for chaining
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
setTimeZone(timeZone)
Sets the time zone of the calendar.
// Gets the user's default calendar. To get a different calendar, // use getCalendarById() instead. const calendar = CalendarApp.getDefaultCalendar(); // Sets the time zone of the calendar to America/New York (US/Eastern) time. calendar.setTimeZone('America/New_York');Parameters Name Type Description
timeZone
String
The time zone, specified in "long" format (such as "America/New_York", as listed by Joda.org). Return
Calendar
— This calendar for chaining.
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
subscribeToCalendar(id)
Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe.
// Subscribe to the calendar "US Holidays". const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());Parameters Name Type Description
id
String
the ID of the calendar to subscribe to Return
Calendar
— the newly subscribed to calendar
Error
— if no calendar with this ID exists
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
subscribeToCalendar(id, options)
Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe.
// Subscribe to the calendar "US Holidays", and set it to the color blue. const calendar = CalendarApp.subscribeToCalendar( 'en.usa#holiday@group.v.calendar.google.com', {color: CalendarApp.Color.BLUE}, ); Logger.log('Subscribed to the calendar "%s".', calendar.getName());Parameters Name Type Description
id
String
The ID of the calendar to subscribe to. options
Object
A JavaScript object that specifies advanced parameters, as listed below. Advanced parameters Name Type Description color
String
A hexadecimal color string ("#rrggbb") or a value from CalendarApp.Colors
. hidden
Boolean
Whether the calendar is hidden in the user interface (default: false
). selected
Boolean
Whether the calendar's events are displayed in the user interface (default: true
if color
is also specified, false
otherwise). Return
Calendar
— The newly subscribed calendar.
Error
— if no calendar with this ID exists
Scripts that use this method require authorization with one or more of the following scopes or appropriate scopes from the related REST API:
https://www.googleapis.com/auth/calendar
https://www.google.com/calendar/feeds
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-09 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-09 UTC."],[[["The `CalendarApp` class in Google Apps Script lets you interact with Google Calendars to manage events and calendar settings."],["You can create, retrieve, and modify calendar events, including recurring events, using various methods provided by the `CalendarApp` class."],["The `CalendarApp` class also allows you to manage calendar settings, like name, description, color, and visibility."],["Most `CalendarApp` methods require specific authorization scopes to access and modify user calendar data."],["Detailed documentation and code examples are available for each method to guide you in using the `CalendarApp` class effectively."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4