Calendar Service

The Google Calendar service for Apps Script allows scripts to access and modify user calendars.
Various classes like Calendar, CalendarApp, CalendarEvent, and CalendarEventSeries are available to manage calendars and events.
Enums like Color, EventColor, EventType, and Visibility define properties and statuses for calendars and events.
Methods are provided to create, retrieve, modify, and delete calendars and events, including handling guests and recurrences.
Detailed methods are available for managing individual events and entire recurring event series.

This service allows a script to access and modify the user's Google Calendar, including additional calendars that the user is subscribed to.

Classes

Name	Brief description
`Calendar`	Represents a calendar that the user owns or is subscribed to.
`CalendarApp`	Allows a script to read and update the user's Google Calendar.
`CalendarEvent`	Represents a single calendar event.
`CalendarEventSeries`	Represents a series of events (a recurring event).
`Color`	An enum representing the named colors available in the Calendar service.
`EventColor`	An enum representing the named event colors available in the Calendar service.
`EventGuest`	Represents a guest of an event.
`EventRecurrence`	Represents the recurrence settings for an event series.
`EventTransparency`	An enum representing the transparency of an event.
`EventType`	An enum representing the type of an event.
`GuestStatus`	An enum representing the statuses a guest can have for an event.
`RecurrenceRule`	Represents a recurrence rule for an event series.
`Visibility`	An enum representing the visibility of an event.

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.
`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.
`deleteCalendar()`	`void`	Deletes the calendar permanently.
`getColor()`	`String`	Gets the color of the 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.
`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.
`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.
`unsubscribeFromCalendar()`	`void`	Unsubscribes the user from a calendar.

`CalendarApp`

Properties

Property	Type	Description
`Color`	`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.

`Color`

Properties

Property	Type	Description
`BLUE`	`Enum`	Blue (`#2952A3`).
`BROWN`	`Enum`	Brown (`#8D6F47`).
`CHARCOAL`	`Enum`	Charcoal (`#4E5D6C`).
`CHESTNUT`	`Enum`	Chestnut (`#865A5A`).
`GRAY`	`Enum`	Gray (`#5A6986`).
`GREEN`	`Enum`	Green (`#0D7813`).
`INDIGO`	`Enum`	Indigo (`#5229A3`).
`LIME`	`Enum`	Lime (`#528800`).
`MUSTARD`	`Enum`	Mustard (`#88880E`).
`OLIVE`	`Enum`	Olive (`#6E6E41`).
`ORANGE`	`Enum`	Orange (`#BE6D00`).
`PINK`	`Enum`	Pink (`#B1365F`).
`PLUM`	`Enum`	Plum (`#705770`).
`PURPLE`	`Enum`	Purple (`#7A367A`).
`RED`	`Enum`	Red (`#A32929`).
`RED_ORANGE`	`Enum`	Red-Orange (`#B1440E`).
`SEA_BLUE`	`Enum`	Sea Blue (`#29527A`).
`SLATE`	`Enum`	Slate (`#4A716C`).
`TEAL`	`Enum`	Teal (`#28754E`).
`TURQOISE`	`Enum`	Turquoise (`#1B887A`).
`YELLOW`	`Enum`	Yellow (`#AB8B00`).

`EventColor`

Properties

Property	Type	Description
`PALE_BLUE`	`Enum`	Pale Blue (`"1"`), referred to as "Peacock" in th Calendar UI.
`PALE_GREEN`	`Enum`	Pale Green (`"2"`), referred to as "Sage" in th Calendar UI.
`MAUVE`	`Enum`	Mauve (`"3"`),, referred to as "Grape" in th Calendar UI.
`PALE_RED`	`Enum`	Pale Red (`"4"`), referred to as "Flamingo" in th Calendar UI.
`YELLOW`	`Enum`	Yellow (`"5"`), referred to as "Banana" in th Calendar UI.
`ORANGE`	`Enum`	Orange (`"6"`), referred to as "Tangerine" in th Calendar UI.
`CYAN`	`Enum`	Cyan (`"7"`), referred to as "Lavender" in th Calendar UI.
`GRAY`	`Enum`	Gray (`"8"`), referred to as "Graphite" in th Calendar UI.
`BLUE`	`Enum`	Blue (`"9"`), referred to as "Blueberry" in th Calendar UI.
`GREEN`	`Enum`	Green (`"10"`), referred to as "Basil" in th Calendar UI.
`RED`	`Enum`	Red (`"11"`), referred to as "Tomato" in th Calendar UI.

`EventTransparency`

Properties

Property	Type	Description
`OPAQUE`	`Enum`	The event does block time on the calendar.
`TRANSPARENT`	`Enum`	The event does not block time on the calendar.

`EventType`

Properties

Property	Type	Description
`DEFAULT`	`Enum`	The event is a regular event.
`BIRTHDAY`	`Enum`	The event is a special all-day event with an annual recurrence.
`FOCUS_TIME`	`Enum`	The event is a focus-time event.
`FROM_GMAIL`	`Enum`	The event is an event from Gmail.
`OUT_OF_OFFICE`	`Enum`	The event is an out-of-office event.
`WORKING_LOCATION`	`Enum`	The event is a working location event.

`GuestStatus`

Properties

Property	Type	Description
`INVITED`	`Enum`	The guest has been invited, but has not indicated whether they are attending.
`MAYBE`	`Enum`	The guest has indicated they might attend.
`NO`	`Enum`	The guest has indicated they are not attending.
`OWNER`	`Enum`	The guest is the owner of the event.
`YES`	`Enum`	The guest has indicated they are attending.

`Visibility`

Properties

Property	Type	Description
`CONFIDENTIAL`	`Enum`	The event is private.
`DEFAULT`	`Enum`	Uses the default visibility for events on the calendar.
`PRIVATE`	`Enum`	The event is private and only event attendees may view event details.
`PUBLIC`	`Enum`	The event is public and event details are visible to all readers of the calendar.

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 2025-12-11 UTC.

Calendar Service

Classes

Methods

`CalendarApp`

Properties

Methods

`CalendarEvent`

`CalendarEventSeries`

`Color`

Properties

`EventColor`

Properties

`EventGuest`

`EventRecurrence`

`EventTransparency`

Properties

`EventType`

Properties

`GuestStatus`

Properties

`RecurrenceRule`

`Visibility`

Properties