Class CalendarEventSeries

Calendar Event Series

Represents a series of events (a recurring event).

Methods

Method	Return type	Brief description
`add Email Reminder(minutesBefore)`	`Calendar Event Series`	Adds a new email reminder to the event.
`add Guest(email)`	`Calendar Event Series`	Adds a guest to the event.
`add Popup Reminder(minutesBefore)`	`Calendar Event Series`	Adds a new pop-up notification to the event.
`add Sms Reminder(minutesBefore)`	`Calendar Event Series`	Adds a new SMS reminder to the event.
`anyone Can Add Self()`	`Boolean`	Determines whether people can add themselves as guests to a Calendar event.
`delete Event Series()`	`void`	Deletes the event series.
`delete Tag(key)`	`Calendar Event Series`	Deletes a key/value tag from the event.
`get All Tag Keys()`	`String[]`	Gets all keys for tags that have been set on the event.
`get Color()`	`String`	Returns the color of the calendar event.
`get Creators()`	`String[]`	Gets the creators of an event.
`get Date Created()`	`Date`	Gets the date the event was created.
`get Description()`	`String`	Gets the description of the event.
`get Email Reminders()`	`Integer[]`	Gets the minute values for all email reminders for the event.
`get Event Type()`	`Event Type`	Gets the `Event Type` of this event.
`get Guest By Email(email)`	`Event Guest`	Gets a guest by email address.
`get Guest List()`	`Event Guest[]`	Gets the guests for the event, not including the event owner.
`get Guest List(includeOwner)`	`Event Guest[]`	Gets the guests for the event, potentially including the event owners.
`get Id()`	`String`	Gets the unique iCalUID of the event.
`get Last Updated()`	`Date`	Gets the date the event was last updated.
`get Location()`	`String`	Gets the location of the event.
`get My Status()`	`Guest Status`	Gets the event status (such as attending or invited) of the effective user.
`get Original Calendar Id()`	`String`	Get the ID of the calendar where this event was originally created.
`get Popup Reminders()`	`Integer[]`	Gets the minute values for all pop-up reminders for the event.
`get Sms Reminders()`	`Integer[]`	Gets the minute values for all SMS reminders for the event.
`get Tag(key)`	`String`	Gets a tag value of the event.
`get Title()`	`String`	Gets the title of the event.
`get Transparency()`	`Event Transparency`	Gets the transparency of the event.
`get Visibility()`	`Visibility`	Gets the visibility of the event.
`guests Can Invite Others()`	`Boolean`	Determines whether guests can invite other guests.
`guests Can Modify()`	`Boolean`	Determines whether guests can modify the event.
`guests Can See Guests()`	`Boolean`	Determines whether guests can see other guests.
`is Owned By Me()`	`Boolean`	Determines whether you're the owner of the event.
`remove All Reminders()`	`Calendar Event Series`	Removes all reminders from the event.
`remove Guest(email)`	`Calendar Event Series`	Removes a guest from the event.
`reset Reminders To Default()`	`Calendar Event Series`	Resets the reminders using the calendar's default settings.
`set Anyone Can Add Self(anyoneCanAddSelf)`	`Calendar Event Series`	Sets whether non-guests can add themselves to the event.
`set Color(color)`	`Calendar Event Series`	Sets the color of the calendar event.
`set Description(description)`	`Calendar Event Series`	Sets the description of the event.
`set Guests Can Invite Others(guestsCanInviteOthers)`	`Calendar Event Series`	Sets whether guests can invite other guests.
`set Guests Can Modify(guestsCanModify)`	`Calendar Event Series`	Sets whether guests can modify the event.
`set Guests Can See Guests(guestsCanSeeGuests)`	`Calendar Event Series`	Sets whether guests can see other guests.
`set Location(location)`	`Calendar Event Series`	Sets the location of the event.
`set My Status(status)`	`Calendar Event Series`	Sets the event status (such as attending or invited) of the effective user.
`set Recurrence(recurrence, startDate)`	`Calendar Event Series`	Sets the recurrence rules for an all-day event series.
`set Recurrence(recurrence, startTime, endTime)`	`Calendar Event Series`	Sets the recurrence rules for this event series.
`set Tag(key, value)`	`Calendar Event Series`	Sets a key/value tag on the event, for storing custom metadata.
`set Title(title)`	`Calendar Event Series`	Sets the title of the event.
`set Transparency(transparency)`	`Calendar Event Series`	Sets the transparency of the event.
`set Visibility(visibility)`	`Calendar Event Series`	Sets the visibility of the event.

Detailed documentation

`add Email Reminder(minutesBefore)`

Adds a new email reminder to the event. The reminder must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Adds an email notification for 15 minutes before the event. 
 event 
 . 
 addEmailReminder 
 ( 
 15 
 );

Parameters

Name	Type	Description
`minutes Before`	`Integer`	the number of minutes before the event

Return

Calendar Event Series — this Calendar Event Series for chaining

Throws

Error — if there are more than 5 reminders on the event or the time is not within the legal range

Authorization

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

`add Guest(email)`

Adds a guest to the event.

 // Example 1: Add a guest to one event 
 function 
  
 addAttendeeToEvent 
 () 
  
 { 
  
 // Replace the below values with your own 
  
 const 
  
 attendeeEmail 
  
 = 
  
 'user@example.com' 
 ; 
  
 // Email address of the person you need to add 
  
 const 
  
 calendarId 
  
 = 
  
 'calendar_123@group.calendar.google.com' 
 ; 
  
 // ID of calendar containing 
  
 // event 
  
 const 
  
 eventId 
  
 = 
  
 '123abc' 
 ; 
  
 // ID of event instance 
  
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
 calendarId 
 ); 
  
 if 
  
 ( 
 calendar 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Calendar not found 
  
 console 
 . 
 log 
 ( 
 'Calendar not found' 
 , 
  
 calendarId 
 ); 
  
 return 
 ; 
  
 } 
  
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEventById 
 ( 
 eventId 
 ); 
  
 if 
  
 ( 
 event 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Event not found 
  
 console 
 . 
 log 
 ( 
 'Event not found' 
 , 
  
 eventId 
 ); 
  
 return 
 ; 
  
 } 
  
 event 
 . 
 addGuest 
 ( 
 attendeeEmail 
 ); 
 } 
 // Example 2: Add a guest to all events on a calendar within a specified 
 // timeframe 
 function 
  
 addAttendeeToAllEvents 
 () 
  
 { 
  
 // Replace the following values with your own 
  
 const 
  
 attendeeEmail 
  
 = 
  
 'user@example.com' 
 ; 
  
 // Email address of the person you need to add 
  
 const 
  
 calendarId 
  
 = 
  
 'calendar_123@group.calendar.google.com' 
 ; 
  
 // ID of calendar with the 
  
 // events 
  
 const 
  
 startDate 
  
 = 
  
 new 
  
 Date 
 ( 
 'YYYY-MM-DD' 
 ); 
  
 // The first date to add the guest to the events 
  
 const 
  
 endDate 
  
 = 
  
 new 
  
 Date 
 ( 
 'YYYY-MM-DD' 
 ); 
  
 // The last date to add the guest to the events 
  
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
 calendarId 
 ); 
  
 if 
  
 ( 
 calendar 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Calendar not found 
  
 console 
 . 
 log 
 ( 
 'Calendar not found' 
 , 
  
 calendarId 
 ); 
  
 return 
 ; 
  
 } 
  
 // Get the events within the specified timeframe 
  
 const 
  
 calEvents 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
 startDate 
 , 
  
 endDate 
 ); 
  
 console 
 . 
 log 
 ( 
 calEvents 
 . 
 length 
 ); 
  
 // Checks how many events are found 
  
 // Loop through all events and add the attendee to each of them 
  
 for 
  
 ( 
 let 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 calEvents 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 const 
  
 event 
  
 = 
  
 calEvents 
 [ 
 i 
 ]; 
  
 event 
 . 
 addGuest 
 ( 
 attendeeEmail 
 ); 
  
 } 
 }

Parameters

Name	Type	Description
`email`	`String`	The email address of the guest.

Return

Calendar Event Series — This Calendar Event Series for chaining.

Authorization

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

`add Popup Reminder(minutesBefore)`

Adds a new pop-up notification to the event. The notification must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Adds a pop-up notification for 15 minutes before the event. 
 event 
 . 
 addPopupReminder 
 ( 
 15 
 );

Parameters

Name	Type	Description
`minutes Before`	`Integer`	the number of minutes before the event

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`add Sms Reminder(minutesBefore)`

Adds a new SMS reminder to the event. The reminder must be at least 5 minutes, and at most 4 weeks (40320 minutes), before the event.

Parameters

Name	Type	Description
`minutes Before`	`Integer`	the number of minutes before the event

Return

Calendar Event Series — this Calendar Event Series for chaining

Throws

Error — if there are more than 5 reminders on the event or the time is not within the legal range

Authorization

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

`anyone Can Add Self()`

Determines whether people can add themselves as guests to a Calendar event.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Determines whether people can add themselves as guests to the event and logs 
 // it. 
 console 
 . 
 log 
 ( 
 event 
 . 
 anyoneCanAddSelf 
 ());

Return

Boolean — true if non-guests can add themselves to the event; false if not

Authorization

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

`delete Event Series()`

Deletes the event series.

Authorization

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

`delete Tag(key)`

Deletes a key/value tag from the event.

Parameters

Name	Type	Description
`key`	`String`	the tag key

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`get All Tag Keys()`

Gets all keys for tags that have been set on the event.

Return

String[] — an array of string keys

Authorization

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

`get Color()`

Returns the color of the calendar event.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Gets the color of the calendar event and logs it. 
 const 
  
 eventColor 
  
 = 
  
 event 
 . 
 getColor 
 (); 
 console 
 . 
 log 
 ( 
 eventColor 
 );

Return

String — The string representation of the event color, as an index (1-11) of values from Calendar App.EventColor .

Authorization

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

`get Creators()`

Gets the creators of an event.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Gets a list of the creators of the event and logs it. 
 console 
 . 
 log 
 ( 
 event 
 . 
 getCreators 
 ());

Return

String[] — the email addresses of the event's creators

Authorization

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

`get Date Created()`

Gets the date the event was created. You must have access to the calendar.

 // Opens the calendar by using its ID. 
 // To get the user's default calendar use CalendarApp.getDefault() instead. 
 // TODO(developer): Replace the calendar ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 8:10 AM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 08:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, gets the date that the 
  
 // event was created and logs it. 
  
 const 
  
 eventCreated 
  
 = 
  
 event 
 . 
 getDateCreated 
 (); 
  
 console 
 . 
 log 
 ( 
 eventCreated 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Date — the date of creation

Authorization

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

`get Description()`

Gets the description of the event. You must have edit access to the calendar.

 // Opens the calendar by its ID. 
 // To get the user's default calendar use CalendarApp.getDefault() instead. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 4th, 2023 that takes 
 // place between 4:00 PM and 5:00 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 16:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 17:00:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the description of the 
  
 // event. 
  
 event 
 . 
 setDescription 
 ( 
 'Important meeting' 
 ); 
  
 // Gets the description of the event and logs it. 
  
 const 
  
 description 
  
 = 
  
 event 
 . 
 getDescription 
 (); 
  
 console 
 . 
 log 
 ( 
 description 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

String — the description

Authorization

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

`get Email Reminders()`

Gets the minute values for all email reminders for the event. You must have edit access to the calendar.

 // Opens the calendar by its ID. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 4th, 2023 that takes 
 // place between 5:00 PM and 6:00 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 15:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 18:00:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, adds email reminders for 
  
 // the user to be sent at 4 and 7 minutes before the event. 
  
 event 
 . 
 addEmailReminder 
 ( 
 4 
 ); 
  
 event 
 . 
 addEmailReminder 
 ( 
 7 
 ); 
  
 // Gets the minute values for all email reminders that are set up for the user 
  
 // for this event and logs it. 
  
 const 
  
 emailReminder 
  
 = 
  
 event 
 . 
 getEmailReminders 
 (); 
  
 console 
 . 
 log 
 ( 
 emailReminder 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Integer[] — an array in which each value corresponds to the number of minutes before the event that a reminder triggers

Authorization

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

`get Event Type()`

Gets the Event Type of this event.

 // Opens the default calendar and logs all out-of-office events for the current day. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getDefaultCalendar 
 (); 
 const 
  
 events 
  
 = 
  
 calendar 
 . 
 getEventsForDay 
 ( 
 new 
  
 Date 
 ()); 
 console 
 . 
 log 
 ( 
 events 
 . 
 filter 
 ( 
 e 
  
 = 
>  
 e 
 . 
 getEventType 
 () 
  
 === 
  
 CalendarApp 
 . 
 EventType 
 . 
 OUT_OF_OFFICE 
 ));

Return

Event Type — The event type.

Authorization

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

`get Guest By Email(email)`

Gets a guest by email address.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 25th, 2023 that takes 
 // place between 5:00 PM and 5:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 // Gets a guest by email address. 
 const 
  
 guestEmailId 
  
 = 
  
 event 
 . 
 getGuestByEmail 
 ( 
 'alex@example.com' 
 ); 
 // If the email address corresponds to an event guest, logs the email address. 
 if 
  
 ( 
 guestEmailId 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 guestEmailId 
 . 
 getEmail 
 ()); 
 }

Parameters

Name	Type	Description
`email`	`String`	the address of the guest

Return

Event Guest — the guest, or null if the email address does not correspond to a guest

Authorization

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

`get Guest List()`

Gets the guests for the event, not including the event owner.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 25th, 2023 that takes 
 // place between 5:00 PM and 5:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 // Adds two guests to the event by using their email addresses. 
 event 
 . 
 addGuest 
 ( 
 'alex@example.com' 
 ); 
 event 
 . 
 addGuest 
 ( 
 'cruz@example.com' 
 ); 
 // Gets the guests list for the event. 
 const 
  
 guestList 
  
 = 
  
 event 
 . 
 getGuestList 
 (); 
 // Loops through the list to get all the guests and logs their email addresses. 
 for 
  
 ( 
 const 
  
 guest 
  
 of 
  
 guestList 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 guest 
 . 
 getEmail 
 ()); 
 }

Return

Event Guest[] — an array of the guests

Authorization

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

`get Guest List(includeOwner)`

Gets the guests for the event, potentially including the event owners.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 25th, 2023 that takes 
 // place between 5:00 PM and 5:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 17:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 // Gets the guests list for the event, including the owner of the event. 
 const 
  
 guestList 
  
 = 
  
 event 
 . 
 getGuestList 
 ( 
 true 
 ); 
 // Loops through the list to get all the guests and logs it. 
 for 
  
 ( 
 const 
  
 guest 
  
 of 
  
 guestList 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 guest 
 . 
 getEmail 
 ()); 
 }

Parameters

Name	Type	Description
`include Owner`	`Boolean`	whether to include the owners as a guest

Return

Event Guest[] — an array of the guests

Authorization

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

`get Id()`

Gets the unique iCalUID of the event. Note that the iCalUID and the event id used by the Calendar v3 API and Calendar advanced service are not identical and cannot be used interchangeably. One difference in their semantics is that in recurring events all occurrences of one event have different ids while they all share the same iCalUIDs.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for January 5th, 2023 that takes place 
 // between 9:00 AM and 9:25 AM. 
 // For an event series, use calendar.getEventSeriesById('abc123456@google.com'); 
 // and replace the series ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Jan 05, 2023 09:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Jan 05, 2023 09:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 // Gets the ID of the event and logs it. 
 console 
 . 
 log 
 ( 
 event 
 . 
 getId 
 ());

Return

String — the iCalUID of the event

Authorization

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

`get Last Updated()`

Gets the date the event was last updated.

 // Opens the calendar by its ID. You must have view access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:00 PM and 5:00 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 17:00:00' 
 ), 
  
 )[ 
 0 
 ]; 
 // Gets the date the event was last updated and logs it. 
 const 
  
 eventUpdatedDate 
  
 = 
  
 event 
 . 
 getLastUpdated 
 (); 
 console 
 . 
 log 
 ( 
 eventUpdatedDate 
 );

Return

Date — the last updated date

Authorization

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

`get Location()`

Gets the location of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the location of the 
  
 // event to Mumbai. 
  
 event 
 . 
 setLocation 
 ( 
 'Mumbai' 
 ); 
  
 // Gets the location of the event and logs it. 
  
 const 
  
 eventLocation 
  
 = 
  
 event 
 . 
 getLocation 
 (); 
  
 console 
 . 
 log 
 ( 
 eventLocation 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

String — the event location

Authorization

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

`get My Status()`

Gets the event status (such as attending or invited) of the effective user. Always returns Guest Status.OWNER if the effective user is the owner of the event.

 // Opens the calendar by its ID. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, gets the event status of 
  
 // the effective user and logs it. 
  
 const 
  
 myStatus 
  
 = 
  
 event 
 . 
 getMyStatus 
 (); 
  
 console 
 . 
 log 
 ( 
 myStatus 
 . 
 toString 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Guest Status — the status

Authorization

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

`get Original Calendar Id()`

Get the ID of the calendar where this event was originally created.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 25th, 2023 that takes 
 // place between 4:00 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 16:00:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 25,2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, gets the ID of the calendar 
  
 // where the event was originally created and logs it. 
  
 const 
  
 calendarId 
  
 = 
  
 event 
 . 
 getOriginalCalendarId 
 (); 
  
 console 
 . 
 log 
 ( 
 calendarId 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

String — the ID of the original calendar

Authorization

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

`get Popup Reminders()`

Gets the minute values for all pop-up reminders for the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 4th, 2023 that takes 
 // place between 5:05 PM and 5:35 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 17:05:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 17:35:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, adds two pop-up reminders 
  
 // to the event. The first reminder pops up 5 minutes before the event starts 
  
 // and the second reminder pops up 3 minutes before the event starts. 
  
 event 
 . 
 addPopupReminder 
 ( 
 3 
 ); 
  
 event 
 . 
 addPopupReminder 
 ( 
 5 
 ); 
  
 // Gets the minute values for all pop-up reminders for the event and logs it. 
  
 const 
  
 popUpReminder 
  
 = 
  
 event 
 . 
 getPopupReminders 
 (); 
  
 console 
 . 
 log 
 ( 
 popUpReminder 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Integer[] — an array in which each value corresponds to the number of minutes before the event that a reminder triggers

Authorization

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

`get Sms Reminders()`

Gets the minute values for all SMS reminders for the event.

Return

Integer[] — an array in which each value corresponds to the number of minutes before the event that a reminder triggers

Authorization

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

`get Tag(key)`

Gets a tag value of the event.

Parameters

Name	Type	Description
`key`	`String`	the key

Return

String — the tag value

Authorization

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

`get Title()`

Gets the title of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for January 31st, 2023 that takes 
 // place between 9:05 AM and 9:15 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:05:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:15:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, logs the title of the 
  
 // event. 
  
 console 
 . 
 log 
 ( 
 event 
 . 
 getTitle 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

String — the title

Authorization

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

`get Transparency()`

Gets the transparency of the event. Use this method to determine whether an event is TRANSPARENT , meaning the calendar shows as Available during that time, or OPAQUE , meaning the calendar shows as Busy during that time.

 // Gets the first event from the default calendar for today. 
 const 
  
 today 
  
 = 
  
 new 
  
 Date 
 (); 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getDefaultCalendar 
 (). 
 getEventsForDay 
 ( 
 today 
 )[ 
 0 
 ]; 
 // Gets the event's transparency and logs it. 
 const 
  
 transparency 
  
 = 
  
 event 
 . 
 getTransparency 
 (); 
 Logger 
 . 
 log 
 ( 
 transparency 
 );

Return

Event Transparency — The transparency value.

Authorization

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

`get Visibility()`

Gets the visibility of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, gets the visibility of the 
  
 // event and logs it. 
  
 const 
  
 eventVisibility 
  
 = 
  
 event 
 . 
 getVisibility 
 (); 
  
 console 
 . 
 log 
 ( 
 eventVisibility 
 . 
 toString 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Visibility — the visibility value

Authorization

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

`guests Can Invite Others()`

Determines whether guests can invite other guests.

 // Opens the calendar by its ID. You must have view access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 9:35 AM and 9:40 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:35:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:40:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, determines whether guests 
  
 // can invite other guests and logs it. 
  
 console 
 . 
 log 
 ( 
 event 
 . 
 guestsCanInviteOthers 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Boolean — true if guests can invite others; false if not

Authorization

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

`guests Can Modify()`

Determines whether guests can modify the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 9:35 AM and 9:40 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:35:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:40:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the event so that 
  
 // guests can't modify it. 
  
 event 
 . 
 setGuestsCanModify 
 ( 
 false 
 ); 
  
 // Determines whether guests can modify the event and logs it. 
  
 console 
 . 
 log 
 ( 
 event 
 . 
 guestsCanModify 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Boolean — true if guests can modify the event; false if not

Authorization

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

`guests Can See Guests()`

Determines whether guests can see other guests.

 // Opens the calendar by its ID. You must have view access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 9:35 AM and 9:40 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:35:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:40:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, determines whether guests 
  
 // can see other guests and logs it. 
  
 console 
 . 
 log 
 ( 
 event 
 . 
 guestsCanSeeGuests 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Boolean — true if guests can see other guests; false if not

Authorization

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

`is Owned By Me()`

Determines whether you're the owner of the event.

 // Opens the calendar by its ID. You must have view access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for January 31st, 2023 that takes 
 // place between 9:05 AM and 9:15 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:05:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:15:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, determines whether you're 
  
 // the owner of the event and logs it. 
  
 console 
 . 
 log 
 ( 
 event 
 . 
 isOwnedByMe 
 ()); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Boolean — true if the event is owned by the effective user; false if not

Authorization

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

`remove All Reminders()`

Removes all reminders from the event.

 // Opens the calendar by its ID. You must have edit access to the calendar 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 1,2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 1,2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, removes all reminders from 
  
 // the event. 
  
 event 
 . 
 removeAllReminders 
 (); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`remove Guest(email)`

Removes a guest from the event.

 // Example 1: Remove a guest from one event 
 function 
  
 removeGuestFromEvent 
 () 
  
 { 
  
 // Replace the below values with your own 
  
 const 
  
 attendeeEmail 
  
 = 
  
 'user@example.com' 
 ; 
  
 // Email address of the person you need to remove 
  
 const 
  
 calendarId 
  
 = 
  
 'calendar_123@group.calendar.google.com' 
 ; 
  
 // ID of calendar containing 
  
 // event 
  
 const 
  
 eventId 
  
 = 
  
 '123abc' 
 ; 
  
 // ID of event instance 
  
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
 calendarId 
 ); 
  
 if 
  
 ( 
 calendar 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Calendar not found 
  
 console 
 . 
 log 
 ( 
 'Calendar not found' 
 , 
  
 calendarId 
 ); 
  
 return 
 ; 
  
 } 
  
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEventById 
 ( 
 eventId 
 ); 
  
 if 
  
 ( 
 event 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Event not found 
  
 console 
 . 
 log 
 ( 
 'Event not found' 
 , 
  
 eventId 
 ); 
  
 return 
 ; 
  
 } 
  
 event 
 . 
 removeGuest 
 ( 
 attendeeEmail 
 ); 
 } 
 // Example 2: Remove a guest from all events on a calendar within a specified 
 // timeframe 
 function 
  
 removeGuestFromAllEvents 
 () 
  
 { 
  
 // Replace the following values with your own 
  
 const 
  
 attendeeEmail 
  
 = 
  
 'user@example.com' 
 ; 
  
 // Email address of the person you need to remove 
  
 const 
  
 calendarId 
  
 = 
  
 'calendar_123@group.calendar.google.com' 
 ; 
  
 // ID of calendar with the 
  
 // events 
  
 const 
  
 startDate 
  
 = 
  
 new 
  
 Date 
 ( 
  
 'YYYY-MM-DD' 
 ); 
  
 // The first date to remove the guest from the events 
  
 const 
  
 endDate 
  
 = 
  
 new 
  
 Date 
 ( 
  
 'YYYY-MM-DD' 
 ); 
  
 // The last date to remove the attendee from the events 
  
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
 calendarId 
 ); 
  
 if 
  
 ( 
 calendar 
  
 === 
  
 null 
 ) 
  
 { 
  
 // Calendar not found 
  
 console 
 . 
 log 
 ( 
 'Calendar not found' 
 , 
  
 calendarId 
 ); 
  
 return 
 ; 
  
 } 
  
 // Get the events within the specified timeframe 
  
 const 
  
 calEvents 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
 startDate 
 , 
  
 endDate 
 ); 
  
 console 
 . 
 log 
 ( 
 calEvents 
 . 
 length 
 ); 
  
 // Checks how many events are found 
  
 // Loop through all events and remove the attendee from each of them 
  
 for 
  
 ( 
 let 
  
 i 
  
 = 
  
 0 
 ; 
  
 i 
 < 
 calEvents 
 . 
 length 
 ; 
  
 i 
 ++ 
 ) 
  
 { 
  
 const 
  
 event 
  
 = 
  
 calEvents 
 [ 
 i 
 ]; 
  
 event 
 . 
 removeGuest 
 ( 
 attendeeEmail 
 ); 
  
 } 
 }

Parameters

Name	Type	Description
`email`	`String`	the email address of the guest

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`reset Reminders To Default()`

Resets the reminders using the calendar's default settings.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 1, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 1, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, resets the reminders using 
  
 // the calendar's default settings. 
  
 event 
 . 
 resetRemindersToDefault 
 (); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Anyone Can Add Self(anyoneCanAddSelf)`

Sets whether non-guests can add themselves to the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 15th, 2023 that takes 
 // place between 3:30 PM and 4:30 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 15, 2023 15:30:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 15, 2023 16:30:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the event so that 
  
 // non-guests can't add themselves to the event. 
  
 event 
 . 
 setAnyoneCanAddSelf 
 ( 
 false 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`anyone Can Add Self`	`Boolean`	whether anyone can invite themselves

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Color(color)`

Sets the color of the calendar event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the color of the 
  
 // calendar event to green. 
  
 event 
 . 
 setColor 
 ( 
 CalendarApp 
 . 
 EventColor 
 . 
 GREEN 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`color`	`String`	An integer color index as a string, or a value from `Calendar App.EventColor` .

Return

Calendar Event Series — This calendar event, for chaining.

Authorization

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

`set Description(description)`

Sets the description of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 4th, 2023 that takes 
 // place between 5:05 PM and 5:35 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 17:05:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 04, 2023 17:35:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the description of the 
  
 // event to 'Meeting.' 
  
 event 
 . 
 setDescription 
 ( 
 'Meeting' 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`description`	`String`	the new description

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Guests Can Invite Others(guestsCanInviteOthers)`

Sets whether guests can invite other guests.

 // Opens the calendar by its ID. 
 // TODO(developer): Replace the ID with your own. You must have edit access to 
 // the calendar. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 9:35 AM and 9:40 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:35:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 09:40:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the event so that 
  
 // guests can invite other guests. 
  
 event 
 . 
 setGuestsCanInviteOthers 
 ( 
 true 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`guests Can Invite Others`	`Boolean`	whether guests can invite others

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Guests Can Modify(guestsCanModify)`

Sets whether guests can modify the event.

Parameters

Name	Type	Description
`guests Can Modify`	`Boolean`	whether guests can modify the event

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Guests Can See Guests(guestsCanSeeGuests)`

Sets whether guests can see other guests.

Parameters

Name	Type	Description
`guests Can See Guests`	`Boolean`	whether guests can see others

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Location(location)`

Sets the location of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the location of the 
  
 // event to Noida. 
  
 event 
 . 
 setLocation 
 ( 
 'Noida' 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`location`	`String`	the new location

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set My Status(status)`

Sets the event status (such as attending or invited) of the effective user.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for February 1st, 2023 that takes 
 // place between 4:10 PM and 4:25 PM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:10:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Feb 01, 2023 16:25:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, sets the event status for 
  
 // the current user to maybe. 
  
 event 
 . 
 setMyStatus 
 ( 
 CalendarApp 
 . 
 GuestStatus 
 . 
 MAYBE 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`status`	`Guest Status`	the new status

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Recurrence(recurrence, startDate)`

Sets the recurrence rules for an all-day event series. Applying this method changes a regular event series into an all-day event series.

 // Sets the events in a series to take place every Wednesday in 2013. 
 const 
  
 eventSeries 
  
 = 
  
 CalendarApp 
 . 
 getDefaultCalendar 
 (). 
 getEventSeriesById 
 ( 
  
 '123456789@google.com' 
 , 
 ); 
 const 
  
 startDate 
  
 = 
  
 new 
  
 Date 
 ( 
 'January 2, 2013 03:00:00 PM EST' 
 ); 
 const 
  
 recurrence 
  
 = 
  
 CalendarApp 
 . 
 newRecurrence 
 () 
  
 . 
 addWeeklyRule 
 () 
  
 . 
 onlyOnWeekday 
 ( 
 CalendarApp 
 . 
 Weekday 
 . 
 WEDNESDAY 
 ) 
  
 . 
 until 
 ( 
 new 
  
 Date 
 ( 
 'January 1, 2014' 
 )); 
 eventSeries 
 . 
 setRecurrence 
 ( 
 recurrence 
 , 
  
 startDate 
 );

Parameters

Name	Type	Description
`recurrence`	`Event Recurrence`	the recurrence rules to use
`start Date`	`Date`	the date of the first event in the series (only the day is used; the time is ignored)

Return

Calendar Event Series — this CalendarEventSeries for chaining

Authorization

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

`set Recurrence(recurrence, startTime, endTime)`

Sets the recurrence rules for this event series. Applying this method changes an all-day event series into a regular event series.

 // Sets the events in a series to take place from 3pm to 4pm every Tuesday and 
 // Thursday in 2013. 
 const 
  
 eventSeries 
  
 = 
  
 CalendarApp 
 . 
 getDefaultCalendar 
 (). 
 getEventSeriesById 
 ( 
  
 '123456789@google.com' 
 , 
 ); 
 const 
  
 startTime 
  
 = 
  
 new 
  
 Date 
 ( 
 'January 1, 2013 03:00:00 PM EST' 
 ); 
 const 
  
 endTime 
  
 = 
  
 new 
  
 Date 
 ( 
 'January 1, 2013 04:00:00 PM EST' 
 ); 
 const 
  
 recurrence 
  
 = 
  
 CalendarApp 
 . 
 newRecurrence 
 () 
  
 . 
 addWeeklyRule 
 () 
  
 . 
 onlyOnWeekdays 
 ( 
  
 [ 
 CalendarApp 
 . 
 Weekday 
 . 
 TUESDAY 
 , 
  
 CalendarApp 
 . 
 Weekday 
 . 
 THURSDAY 
 ]) 
  
 . 
 until 
 ( 
 new 
  
 Date 
 ( 
 'January 1, 2014' 
 )); 
 eventSeries 
 . 
 setRecurrence 
 ( 
 recurrence 
 , 
  
 startTime 
 , 
  
 endTime 
 );

Parameters

Name	Type	Description
`recurrence`	`Event Recurrence`	the recurrence rules to use
`start Time`	`Date`	the date and time when the first event in the series starts
`end Time`	`Date`	the date and time when the first event in the series ends

Return

Calendar Event Series — this CalendarEventSeries for chaining

Authorization

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

`set Tag(key, value)`

Sets a key/value tag on the event, for storing custom metadata.

Parameters

Name	Type	Description
`key`	`String`	the tag key
`value`	`String`	the tag value

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Title(title)`

Sets the title of the event.

 // Opens the calendar by its ID. You must have edit access to the calendar. 
 // TODO(developer): Replace the ID with your own. 
 const 
  
 calendar 
  
 = 
  
 CalendarApp 
 . 
 getCalendarById 
 ( 
  
 'abc123456@group.calendar.google.com' 
 , 
 ); 
 // Gets the first event from the calendar for January 31st, 2023 that takes 
 // place between 9:05 AM and 9:15 AM. For an event series, use 
 // calendar.getEventSeriesById('abc123456@google.com'); and replace the series 
 // ID with your own. 
 const 
  
 event 
  
 = 
  
 calendar 
 . 
 getEvents 
 ( 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:05:00' 
 ), 
  
 new 
  
 Date 
 ( 
 'Jan 31, 2023 09:15:00' 
 ), 
  
 )[ 
 0 
 ]; 
 if 
  
 ( 
 event 
 ) 
  
 { 
  
 // If an event exists within the given time frame, changes its title to 
  
 // Event1. 
  
 event 
 . 
 setTitle 
 ( 
 'Event1' 
 ); 
 } 
  
 else 
  
 { 
  
 // If no event exists within the given time frame, logs that information to 
  
 // the console. 
  
 console 
 . 
 log 
 ( 
 'No events exist for the specified range' 
 ); 
 }

Parameters

Name	Type	Description
`title`	`String`	the new title

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

`set Transparency(transparency)`

Sets the transparency of the event. Use this method to set whether an event is TRANSPARENT , meaning the calendar shows as Available during that time, or OPAQUE , meaning the calendar shows as Busy during that time.

 // Gets an event by its ID. For an event series, use getEventSeriesById(iCalId) 
 // instead. 
 // TODO(developer): Replace the string with the event ID that you want to get. 
 const 
  
 event 
  
 = 
  
 CalendarApp 
 . 
 getEventById 
 ( 
 'abc123456' 
 ); 
 // Sets the event's transparency to TRANSPARENT. 
 event 
 . 
 setTransparency 
 ( 
 CalendarApp 
 . 
 EventTransparency 
 . 
 TRANSPARENT 
 );

Parameters

Name	Type	Description
`transparency`	`Event Transparency`	The transparency value.

Return

Calendar Event Series — This Calendar Event Series for chaining.

Authorization

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

`set Visibility(visibility)`

Sets the visibility of the event.

Parameters

Name	Type	Description
`visibility`	`Visibility`

Return

Calendar Event Series — this Calendar Event Series for chaining

Authorization

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

Class CalendarEventSeries Stay organized with collections Save and categorize content based on your preferences.

Methods

Detailed documentation

add Email Reminder(minutesBefore)

Parameters

Return

Throws

Authorization

add Guest(email)

Parameters

Return

Authorization

add Popup Reminder(minutesBefore)

Parameters

Return

Authorization

add Sms Reminder(minutesBefore)

Parameters

Return

Throws

Authorization

anyone Can Add Self()

Return

Authorization

delete Event Series()

Authorization

delete Tag(key)

Parameters

Return

Authorization

get All Tag Keys()

Return

Authorization

get Color()

Return

Authorization

get Creators()

Return

Authorization

get Date Created()

Return

Authorization

get Description()

Return

Authorization

get Email Reminders()

Return

Authorization

get Event Type()

Return

Authorization

get Guest By Email(email)

Parameters

Return

Authorization

get Guest List()

Return

Authorization

get Guest List(includeOwner)

Parameters

Return

Authorization

get Id()

Return

Authorization

get Last Updated()

Return

Authorization

get Location()

Return

Authorization

get My Status()

Return

Authorization

get Original Calendar Id()

Return

Authorization

get Popup Reminders()

Return

Authorization

Class CalendarEventSeries

`add Email Reminder(minutesBefore)`

`add Guest(email)`

`add Popup Reminder(minutesBefore)`

`add Sms Reminder(minutesBefore)`

`anyone Can Add Self()`

`delete Event Series()`

`delete Tag(key)`

`get All Tag Keys()`

`get Color()`

`get Creators()`

`get Date Created()`

`get Description()`

`get Email Reminders()`

`get Event Type()`

`get Guest By Email(email)`

`get Guest List()`

`get Guest List(includeOwner)`

`get Id()`

`get Last Updated()`

`get Location()`

`get My Status()`

`get Original Calendar Id()`

`get Popup Reminders()`

`get Sms Reminders()`

`get Tag(key)`

`get Title()`

`get Transparency()`

`get Visibility()`

`guests Can Invite Others()`

`guests Can Modify()`

`guests Can See Guests()`

`is Owned By Me()`

`remove All Reminders()`

`remove Guest(email)`

`reset Reminders To Default()`

`set Anyone Can Add Self(anyoneCanAddSelf)`

`set Color(color)`

`set Description(description)`

`set Guests Can Invite Others(guestsCanInviteOthers)`

`set Guests Can Modify(guestsCanModify)`

`set Guests Can See Guests(guestsCanSeeGuests)`

`set Location(location)`

`set My Status(status)`