Class CalendarEventSeries

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.

Parameters

Return

CalendarEventSeries — this CalendarEventSeries 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

Adds a guest to the event.

// Example 1: Add a guest to one event
function addAttendeeToEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let 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
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to add
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to add the guest to the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to add the guest to the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let 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 (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.addGuest(attendeeEmail);
  }
}

Parameters

Return

CalendarEventSeries — 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

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

Parameters

Return

CalendarEventSeries — 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

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

Return

CalendarEventSeries — this CalendarEventSeries 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

Determines whether anyone can invite themselves.

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

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

Deletes a key/value tag from the event.

Parameters

Return

CalendarEventSeries — 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

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

Returns the color of the calendar event.

Return

String — The string representation of the event color, as an index (1-11) of values from CalendarApp.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

Gets the creators of the event.

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

Gets the date the event was created.

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

Gets the description of the event.

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

Gets the minute values for all email 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

Gets a guest by email address.

Parameters

Return

EventGuest — 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

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

Return

EventGuest[] — 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

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

Parameters

Return

EventGuest[] — 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

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.

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

Gets the date the event was last updated.

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

Gets the location of the event.

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

Gets the event status (attending, etc.) of the effective user. Always returns GuestStatus.OWNER if the effective user is the owner of the event.

Return

GuestStatus — 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 the ID of the calendar where this event was originally created.

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

Gets the minute values for all popup 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

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

Gets a tag value of the event.

Parameters

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

Gets the title of the event.

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

Gets the visibility of the event.

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

Determines whether guests can invite other guests.

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

Determines whether guests can modify the event.

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

Determines whether guests can see other guests.

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

Determines whether the event is owned by the effective user.

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

Removes all reminders from the event.

Return

CalendarEventSeries — 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

Removes a guest from the event.

// Example 1: Remove a guest from one event
function removeGuestFromEvent() {
  // Replace the below values with your own
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar containing event
  let eventId = '123abc'; // ID of event instance

  let calendar = CalendarApp.getCalendarById(calendarId);
  if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
    }
  let 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
  let attendeeEmail = 'user@example.com'; // Email address of the person you need to remove
  let calendarId = 'calendar_123@group.calendar.google.com'; // ID of calendar with the events
  let startDate = new Date("YYYY-MM-DD"); // The first date to remove the guest from the events
  let endDate = new Date("YYYY-MM-DD"); // The last date to remove the attendee from the events

  let calendar = CalendarApp.getCalendarById(calendarId);
    if (calendar === null) {
    // Calendar not found
    console.log('Calendar not found', calendarId);
    return;
  }
  // Get the events within the specified timeframe
  let 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 (var i = 0; i < calEvents.length; i++) {
  let event = calEvents[i];
  event.removeGuest(attendeeEmail);
  }
}

Parameters

Return

CalendarEventSeries — 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

Resets the reminders using the calendar's default settings.

Return

CalendarEventSeries — 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

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

Parameters

Return

CalendarEventSeries — 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

Sets the color of the calendar event.

Parameters

Return

CalendarEventSeries — 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

Sets the description of the event.

Parameters

Return

CalendarEventSeries — 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

Sets whether guests can invite other guests.

Parameters

Return

CalendarEventSeries — 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

Sets whether guests can modify the event.

Parameters

Return

CalendarEventSeries — 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

Sets whether guests can see other guests.

Parameters

Return

CalendarEventSeries — 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

Sets the location of the event.

Parameters

Return

CalendarEventSeries — 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

Sets the event status (attending, etc.) of the effective user.

Parameters

Return

CalendarEventSeries — 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.googleapis.com/auth/calendar.readonly
• https://www.google.com/calendar/feeds

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.
var eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById('123456789@google.com');
var startDate = new Date('January 2, 2013 03:00:00 PM EST');
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
    .onlyOnWeekday(CalendarApp.Weekday.WEDNESDAY)
    .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startDate);

Parameters

Return

CalendarEventSeries — 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

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.
var eventSeries = CalendarApp.getDefaultCalendar().getEventSeriesById('123456789@google.com');
var startTime = new Date('January 1, 2013 03:00:00 PM EST');
var endTime = new Date('January 1, 2013 04:00:00 PM EST');
var recurrence = CalendarApp.newRecurrence().addWeeklyRule()
     .onlyOnWeekdays([CalendarApp.Weekday.TUESDAY, CalendarApp.Weekday.THURSDAY])
     .until(new Date('January 1, 2014'));
eventSeries.setRecurrence(recurrence, startTime, endTime);

Parameters

Return

CalendarEventSeries — 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

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

Parameters

Return

CalendarEventSeries — 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

Sets the title of the event.

Parameters

Return

CalendarEventSeries — 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

Sets the visibility of the event.

Parameters

Return

CalendarEventSeries — 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