Creates a new all-day event.

// Creates an all-day event for the moon landing and logs the ID.constevent=CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',newDate('July 20, 1969'),);Logger.log(`Event ID:${event.getId()}`);

Parameters

Return

CalendarEvent — The created event.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

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.constevent=CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',newDate('August 15, 1969'),newDate('August 18, 1969'),);Logger.log(`Event ID:${event.getId()}`);

Parameters

Return

CalendarEvent — The created event.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

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.constevent=CalendarApp.getDefaultCalendar().createAllDayEvent('Woodstock Festival',newDate('August 15, 1969'),newDate('August 18, 1969'),{location:'Bethel, White Lake, New York, U.S.',sendInvites:true},);Logger.log(`Event ID:${event.getId()}`);

Parameters

Advanced parameters

Return

CalendarEvent — The created event.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new all-day event.

// Creates an all-day event for the moon landing and logs the ID.constevent=CalendarApp.getDefaultCalendar().createAllDayEvent('Apollo 11 Landing',newDate('July 20, 1969'),{location:'The Moon'},);Logger.log(`Event ID:${event.getId()}`);

Parameters

Advanced parameters

Return

CalendarEvent — The created event.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new all-day event series.

// Creates an event series for a no-meetings day, taking place every Wednesday// in 2013.consteventSeries=CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings',newDate('January 2, 2013 03:00:00 PM EST'),CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY).until(newDate('January 1, 2014')),);Logger.log(`Event Series ID:${eventSeries.getId()}`);

Parameters

Return

CalendarEventSeries — the created event series

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new all-day event series.

// Creates an event series for a no-meetings day, taking place every Wednesday// in 2013.consteventSeries=CalendarApp.getDefaultCalendar().createAllDayEventSeries('No Meetings',newDate('January 2, 2013 03:00:00 PM EST'),CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY).until(newDate('January 1, 2014')),{guests:'everyone@example.com'},);Logger.log(`Event Series ID:${eventSeries.getId()}`);

Parameters

Advanced parameters

Return

CalendarEventSeries — the created event series

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new event.

If no time zone is specified, the time values are interpreted in the context of the script'stime zone, which may be different than the calendar's time zone.

// Creates an event for the moon landing and logs the ID.constevent=CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',newDate('July 20, 1969 20:00:00 UTC'),newDate('July 21, 1969 21:00:00 UTC'),);Logger.log(`Event ID:${event.getId()}`);

Parameters

Return

CalendarEvent — the created event

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new event.

If no time zone is specified, the time values are interpreted in the context of the script'stime zone, which may be different than the calendar's time zone.

// Creates an event for the moon landing and logs the ID.constevent=CalendarApp.getDefaultCalendar().createEvent('Apollo 11 Landing',newDate('July 20, 1969 20:00:00 UTC'),newDate('July 20, 1969 21:00:00 UTC'),{location:'The Moon'},);Logger.log(`Event ID:${event.getId()}`);

Parameters

Advanced parameters

Return

CalendarEvent — the created event

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

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.constevent=CalendarApp.getDefaultCalendar().createEventFromDescription('Lunch with Mary, Friday at 1PM',);Logger.log(`Event ID:${event.getId()}`);

Parameters

Return

CalendarEvent — the created event

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new event series.

// Creates an event series for a team meeting, taking place every Tuesday and// Thursday in 2013.consteventSeries=CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',newDate('January 1, 2013 03:00:00 PM EST'),newDate('January 1, 2013 04:00:00 PM EST'),CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekdays([CalendarApp.Weekday.TUESDAY,CalendarApp.Weekday.THURSDAY]).until(newDate('January 1, 2014')),);Logger.log(`Event Series ID:${eventSeries.getId()}`);

Parameters

Return

CalendarEventSeries — the created event series

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Creates a new event series.

// Creates an event series for a team meeting, taking place every Tuesday and// Thursday in 2013.consteventSeries=CalendarApp.getDefaultCalendar().createEventSeries('Team Meeting',newDate('January 1, 2013 03:00:00 PM EST'),newDate('January 1, 2013 04:00:00 PM EST'),CalendarApp.newRecurrence().addWeeklyRule().onlyOnWeekdays([CalendarApp.Weekday.TUESDAY,CalendarApp.Weekday.THURSDAY]).until(newDate('January 1, 2014')),{location:'Conference Room'},);Logger.log(`Event Series ID:${eventSeries.getId()}`);

Parameters

Advanced parameters

Return

CalendarEventSeries — the created event series

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Deletes the calendar permanently. A user can only delete a calendar they own.

// Creates a calendar to delete.constcalendar=CalendarApp.createCalendar('Test');// Deletes the 'Test' calendar permanently.calendar.deleteCalendar();

Throws

Error — if this is an imported calendar.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Gets the color of the calendar.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=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.constcalendarColor=calendar.getColor();console.log(calendarColor);

Return

String — A hexadecimal color string ("#rrggbb").

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets the description of the calendar.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=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.constdescription=calendar.getDescription();console.log(description);

Return

String — The description of this calendar.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets the event with the given ID. If the series belongs to a calendar other than the defaultcalendar, this method must be called from that calendar. CallingCalendarApp.getEventById(iCalId) onlyreturns an event in the default calendar.

Multiple events may have the same ID if they are part of an event series. In this case thismethod returns only the first event from that series.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=CalendarApp.getCalendarById('222larabrown@gmail.com');// Creates an event for the moon landing.constevent=calendar.createEvent('Apollo 11 Landing',newDate('July 20, 1969 20:05:00 UTC'),newDate('July 20, 1969 20:17:00 UTC'),);// Gets the calendar event ID and logs it to the console.constiCalId=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.constmyEvent=calendar.getEventById(iCalId);console.log(myEvent.getTitle());

Parameters

Return

CalendarEvent — The event with the given ID, ornull if the event doesn't exist or the user cannot access it.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets the event series with the given ID. If the ID given is for a singleCalendarEvent,then aCalendarEventSeries is returned with a single event in the series. Note that ifthe event series belongs to a calendar other than the default calendar, this method must becalled from thatCalendar; callingCalendarApp.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.constcalendar=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.consteventSeries=calendar.createEventSeries('Team meeting',newDate('Jan 1, 2023 13:00:00'),newDate('Jan 1, 2023 14:00:00'),CalendarApp.newRecurrence().addDailyRule().until(newDate('Jan 1, 2024')),);// Gets the ID of the event series.constiCalId=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

Return

CalendarEventSeries — The series with the given ID, ornull if the series doesn't exist or the user cannot access it.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets all events that occur within a given time range.

This method returns events that start during the given time range, end during the timerange, or encompass the time range. If no time zone is specified, the time values areinterpreted in the context of the script's time zone, which may be different from thecalendar's time zone.

// Determines how many events are happening in the next two hours.constnow=newDate();consttwoHoursFromNow=newDate(now.getTime()+2*60*60*1000);constevents=CalendarApp.getDefaultCalendar().getEvents(now,twoHoursFromNow);Logger.log(`Number of events:${events.length}`);

Parameters

Return

CalendarEvent[] — the events that occur within the time range

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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 timerange, or encompasses the time range. If no time zone is specified, the time values areinterpreted in the context of the script's time zone, which may be different from thecalendar's time zone.

Be aware that filtering onauthor,search, orstatusFilters takesplace after applyingstart andmax. This means that the number of eventsreturned may be less thanmax, even though additional events meet the criteria.

// Determines how many events are happening in the next two hours that contain// the term "meeting".constnow=newDate();consttwoHoursFromNow=newDate(now.getTime()+2*60*60*1000);constevents=CalendarApp.getDefaultCalendar().getEvents(now,twoHoursFromNow,{search:'meeting'},);Logger.log(`Number of events:${events.length}`);

Parameters

Advanced parameters

Return

CalendarEvent[] — the events that take place within the time range and match the criteria

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets all events that occur on a given day.

This method returns events if they start during the given day, end during the day, orencompass 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 timezone.

// Determines how many events are happening today.consttoday=newDate();constevents=CalendarApp.getDefaultCalendar().getEventsForDay(today);Logger.log(`Number of events:${events.length}`);

Parameters

Return

CalendarEvent[] — the events that occur on the given date

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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, orencompass 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 timezone.

Be aware that filtering onauthor,search, orstatusFilters takesplace after applyingstart andmax. This means that the number of eventsreturned may be less thanmax, even though additional events meet the criteria.

// Determines how many events are happening today and contain the term// "meeting".consttoday=newDate();constevents=CalendarApp.getDefaultCalendar().getEventsForDay(today,{search:'meeting',});Logger.log(`Number of events:${events.length}`);

Parameters

Advanced parameters

Return

CalendarEvent[] — the events that occur on the given date and match the criteria

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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.constcalendar=CalendarApp.getCalendarById('222larabrown@gmail.com');// Gets the ID of the calendar and logs it to the console.constcalendarId=calendar.getId();console.log(calendarId);

Return

String — The ID of the calendar.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets the name of the calendar.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=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.constcalendarName=calendar.getName();console.log(calendarName);

Return

String — This calendar's name.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Gets the time zone of the calendar.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=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.consttimeZone=calendar.getTimeZone();console.log(timeZone);

Return

String — The time zone, specified in "long" format (for example, "America/New_York", as listed byJoda.org).

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Determines whether the calendar is hidden in the user interface.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=CalendarApp.getCalendarById('222larabrown@gmail.com');// Determines whether the calendar is hidden in the user interface and logs it// to the console. For the default calendar, you can use CalendarApp.isHidden()// instead.constisHidden=calendar.isHidden();console.log(isHidden);

Return

Boolean —true if the calendar is hidden in the user interface;false if it isn't.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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.constcalendar=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.constisMyPrimaryCalendar=calendar.isMyPrimaryCalendar();console.log(isMyPrimaryCalendar);

Return

Boolean —true if the calendar is the default calendar for the effective user;false if it isn't.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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.constcalendar=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.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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.constcalendar=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

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

Sets the color of the calendar.

// Opens the calendar by its ID.// TODO(developer): Replace the ID with your own.constcalendar=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

Return

Calendar — This calendar for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Sets the description of a calendar.

// Gets the user's default calendar. To get a different calendar,// use getCalendarById() instead.constcalendar=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

Return

Calendar — this calendar for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Sets whether the calendar is visible in the user interface.

Parameters

Return

Calendar — this calendar for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Sets the name of the calendar.

// Gets the user's default calendar. To get a different calendar,// use getCalendarById() instead.constcalendar=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

Return

Calendar — this calendar for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

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.constcalendar=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

Return

Calendar — this calendar for chaining

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Sets the time zone of the calendar.

// Gets the user's default calendar. To get a different calendar,// use getCalendarById() instead.constcalendar=CalendarApp.getDefaultCalendar();// Sets the time zone of the calendar to America/New York (US/Eastern) time.calendar.setTimeZone('America/New_York');

Parameters

Return

Calendar — This calendar for chaining.

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds

Unsubscribes the user from a calendar. A user can't unsubscribe from calendars listed under theMy calendars list. They can unsubscribe from calendars listed underOthercalendars.

// Gets the calendar by its ID.// TODO(developer): Replace the calendar ID with the calendar ID that you want// to get.constcalendar=CalendarApp.getCalendarById('abc123456@group.calendar.google.com',);// Unsubscribes the user from the calendar.constresult=calendar.unsubscribeFromCalendar();

Throws

Error — if this is an owned calendar

Authorization

Scripts that use this method require authorization with one or more of the followingscopes or appropriate scopes from therelated REST API:

• https://www.googleapis.com/auth/calendar
• https://www.google.com/calendar/feeds