Class CalendarEventSeries

CalendarEventSeries

Represents a series of events (a recurring event).

Methods

MethodReturn typeBrief description
addEmailReminder(minutesBefore)CalendarEventSeriesAdds a new email reminder to the event.
addGuest(email)CalendarEventSeriesAdds a guest to the event.
addPopupReminder(minutesBefore)CalendarEventSeriesAdds a new popup reminder to the event.
addSmsReminder(minutesBefore)CalendarEventSeriesAdds a new SMS reminder to the event.
anyoneCanAddSelf()BooleanDetermines whether anyone can invite themselves.
deleteEventSeries()voidDeletes the event series.
deleteTag(key)CalendarEventSeriesDeletes a key/value tag from the event.
getAllTagKeys()String[]Gets all keys for tags that have been set on the event.
getColor()StringReturns the color of the calendar event.
getCreators()String[]Gets the creators of the event.
getDateCreated()DateGets the date the event was created.
getDescription()StringGets the description of the event.
getEmailReminders()Integer[]Gets the minute values for all email reminders for the event.
getGuestByEmail(email)EventGuestGets a guest by email address.
getGuestList()EventGuest[]Gets the guests for the event, not including the event owner.
getGuestList(includeOwner)EventGuest[]Gets the guests for the event, potentially including the event owners.
getId()StringGets the unique iCalUID of the event.
getLastUpdated()DateGets the date the event was last updated.
getLocation()StringGets the location of the event.
getMyStatus()GuestStatusGets the event status (attending, etc.) of the effective user.
getOriginalCalendarId()StringGet the ID of the calendar where this event was originally created.
getPopupReminders()Integer[]Gets the minute values for all popup reminders for the event.
getSmsReminders()Integer[]Gets the minute values for all SMS reminders for the event.
getTag(key)StringGets a tag value of the event.
getTitle()StringGets the title of the event.
getVisibility()VisibilityGets the visibility of the event.
guestsCanInviteOthers()BooleanDetermines whether guests can invite other guests.
guestsCanModify()BooleanDetermines whether guests can modify the event.
guestsCanSeeGuests()BooleanDetermines whether guests can see other guests.
isOwnedByMe()BooleanDetermines whether the event is owned by the effective user.
removeAllReminders()CalendarEventSeriesRemoves all reminders from the event.
removeGuest(email)CalendarEventSeriesRemoves a guest from the event.
resetRemindersToDefault()CalendarEventSeriesResets the reminders using the calendar's default settings.
setAnyoneCanAddSelf(anyoneCanAddSelf)CalendarEventSeriesSets whether non-guests can add themselves to the event.
setColor(color)CalendarEventSeriesSets the color of the calendar event.
setDescription(description)CalendarEventSeriesSets the description of the event.
setGuestsCanInviteOthers(guestsCanInviteOthers)CalendarEventSeriesSets whether guests can invite other guests.
setGuestsCanModify(guestsCanModify)CalendarEventSeriesSets whether guests can modify the event.
setGuestsCanSeeGuests(guestsCanSeeGuests)CalendarEventSeriesSets whether guests can see other guests.
setLocation(location)CalendarEventSeriesSets the location of the event.
setMyStatus(status)CalendarEventSeriesSets the event status (attending, etc.) of the effective user.
setRecurrence(recurrence, startDate)CalendarEventSeriesSets the recurrence rules for an all-day event series.
setRecurrence(recurrence, startTime, endTime)CalendarEventSeriesSets the recurrence rules for this event series.
setTag(key, value)CalendarEventSeriesSets a key/value tag on the event, for storing custom metadata.
setTitle(title)CalendarEventSeriesSets the title of the event.
setVisibility(visibility)CalendarEventSeriesSets the visibility of the event.

Detailed documentation

addEmailReminder(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.

Parameters

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

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:

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

addGuest(email)

Adds a guest to the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

addPopupReminder(minutesBefore)

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

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

addSmsReminder(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

NameTypeDescription
minutesBeforeIntegerthe number of minutes before the event

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:

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

anyoneCanAddSelf()

Determines whether anyone can invite themselves.

Return

Booleantrue 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:

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

deleteEventSeries()

Deletes the event series.

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

deleteTag(key)

Deletes a key/value tag from the event.

Parameters

NameTypeDescription
keyStringthe tag key

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getAllTagKeys()

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:

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

getColor()

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.EventColors

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getCreators()

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:

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

getDateCreated()

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:

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

getDescription()

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:

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

getEmailReminders()

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:

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

getGuestByEmail(email)

Gets a guest by email address.

Parameters

NameTypeDescription
emailStringthe address of the guest

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:

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

getGuestList()

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:

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

getGuestList(includeOwner)

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

Parameters

NameTypeDescription
includeOwnerBooleanwhether to include the owners as a guest

Return

EventGuest[] — an array of the guests

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getId()

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 interchangebly. 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:

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

getLastUpdated()

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:

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

getLocation()

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:

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

getMyStatus()

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:

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

getOriginalCalendarId()

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:

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

getPopupReminders()

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:

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

getSmsReminders()

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:

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

getTag(key)

Gets a tag value of the event.

Parameters

NameTypeDescription
keyStringthe key

Return

String — the tag value

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getTitle()

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:

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

getVisibility()

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:

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

guestsCanInviteOthers()

Determines whether guests can invite other guests.

Return

Booleantrue if guests can invite others; false if not

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

guestsCanModify()

Determines whether guests can modify the event.

Return

Booleantrue 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:

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

guestsCanSeeGuests()

Determines whether guests can see other guests.

Return

Booleantrue 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:

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

isOwnedByMe()

Determines whether the event is owned by the effective user.

Return

Booleantrue 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:

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

removeAllReminders()

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:

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

removeGuest(email)

Removes a guest from the event.

Parameters

NameTypeDescription
emailStringthe email address of the guest

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

resetRemindersToDefault()

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:

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

setAnyoneCanAddSelf(anyoneCanAddSelf)

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

Parameters

NameTypeDescription
anyoneCanAddSelfBooleanwhether anyone can invite themselves

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setColor(color)

Sets the color of the calendar event.

Parameters

NameTypeDescription
colorStringan integer color index as a string, or a value from CalendarApp.EventColors

Return

CalendarEventSeries — this calendar event, for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setDescription(description)

Sets the description of the event.

Parameters

NameTypeDescription
descriptionStringthe new description

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setGuestsCanInviteOthers(guestsCanInviteOthers)

Sets whether guests can invite other guests.

Parameters

NameTypeDescription
guestsCanInviteOthersBooleanwhether guests can invite others

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setGuestsCanModify(guestsCanModify)

Sets whether guests can modify the event.

Parameters

NameTypeDescription
guestsCanModifyBooleanwhether guests can modify the event

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setGuestsCanSeeGuests(guestsCanSeeGuests)

Sets whether guests can see other guests.

Parameters

NameTypeDescription
guestsCanSeeGuestsBooleanwhether guests can see others

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setLocation(location)

Sets the location of the event.

Parameters

NameTypeDescription
locationStringthe new location

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setMyStatus(status)

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

Parameters

NameTypeDescription
statusGuestStatusthe new status

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setRecurrence(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.
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

NameTypeDescription
recurrenceEventRecurrencethe recurrence rules to use
startDateDatethe date of the first event in the series (only the day is used; the time is ignored)

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setRecurrence(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.
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

NameTypeDescription
recurrenceEventRecurrencethe recurrence rules to use
startTimeDatethe date and time when the first event in the series starts
endTimeDatethe date and time when the first event in the series ends

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setTag(key, value)

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

Parameters

NameTypeDescription
keyStringthe tag key
valueStringthe tag value

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setTitle(title)

Sets the title of the event.

Parameters

NameTypeDescription
titleStringthe new title

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setVisibility(visibility)

Sets the visibility of the event.

Parameters

NameTypeDescription
visibilityVisibility

Return

CalendarEventSeries — this CalendarEventSeries for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。