Skip to content

Object reference

Calendar event

A calendar event is one entry on a calendar, such as a meeting or a reminder. It carries a title, a start and end time, and an optional guest list.

CalendarApp.CalendarEvent

Start here

Get this object first

Get the events for today from the default calendar, then take the first one. There may be none, so check the length first.

Code.gs 
function showFirstTodaysEventTitle() {
  const events = CalendarApp.getDefaultCalendar().getEventsForDay(new Date());
  if (!events.length) {
    Logger.log('No events today.');
    return;
  }
  Logger.log(events[0].getTitle());
}

Then use it

Common actions

Choose an action, then open its example only when you need the code.

Read the title, start time, end time, and all-day flag

This reads four details about the first event today and does not change it.

CalendarApp.CalendarEvent
Show example code
Code.gs 
function logFirstTodaysEventDetails() {
  const events = CalendarApp.getDefaultCalendar().getEventsForDay(new Date());
  if (!events.length) return;
  const event = events[0];
  Logger.log('Title: ' + event.getTitle());
  Logger.log('Start: ' + event.getStartTime());
  Logger.log('End: ' + event.getEndTime());
  Logger.log('All day: ' + event.isAllDayEvent());
}

Read the guest list

This lists the email addresses invited to the first event today and does not invite or remove anyone.

CalendarApp.CalendarEventCalendarApp.EventGuest
Show example code
Code.gs 
function logFirstTodaysEventGuests() {
  const events = CalendarApp.getDefaultCalendar().getEventsForDay(new Date());
  if (!events.length) return;
  const guests = events[0].getGuestList().map((guest) => guest.getEmail());
  Logger.log(guests.join(', ') || 'No guests');
}

Set the description (this changes the event)

This replaces the description text on the first event today. It does not change the title, time, or guests.

CalendarApp.CalendarEvent
Show example code
Code.gs 
function setFirstTodaysEventDescription() {
  const events = CalendarApp.getDefaultCalendar().getEventsForDay(new Date());
  if (!events.length) return;
  events[0].setDescription('Updated by script.');
  Logger.log('Description set on: ' + events[0].getTitle());
}

Technical reference

Exact names and signatures

Generated runtime and signature facts stay separate from the beginner actions above. Open method details only when you need them.

At a glance

Service
CalendarApp
Reference symbol
CalendarApp.CalendarEvent
Object
CalendarEvent
Runtime
From signature data

Open the Google reference source

Methods and signatures

Browse 56 methods

addEmailReminder

From signature data Google source
  • addEmailReminder(minutesBefore: number): CalendarApp.CalendarEvent

addGuest

From signature data Google source
  • addGuest(email: string): CalendarApp.CalendarEvent

addPopupReminder

From signature data Google source
  • addPopupReminder(minutesBefore: number): CalendarApp.CalendarEvent

addSmsReminder

From signature data Google source
  • addSmsReminder(minutesBefore: number): CalendarApp.CalendarEvent

anyoneCanAddSelf

From signature data Google source
  • anyoneCanAddSelf(): boolean

deleteEvent

From signature data Google source
  • deleteEvent(): void

deleteTag

From signature data Google source
  • deleteTag(key: string): CalendarApp.CalendarEvent

getAllDayEndDate

From signature data Google source
  • getAllDayEndDate(): Date

getAllDayStartDate

From signature data Google source
  • getAllDayStartDate(): Date

getAllTagKeys

From signature data Google source
  • getAllTagKeys(): string[]

getColor

From signature data Google source
  • getColor(): string

getCreators

From signature data Google source
  • getCreators(): string[]

getDateCreated

From signature data Google source
  • getDateCreated(): Date

getDescription

From signature data Google source
  • getDescription(): string

getEmailReminders

From signature data Google source
  • getEmailReminders(): number[]

getEndTime

From signature data Google source
  • getEndTime(): Date

getEventSeries

From signature data Google source
  • getEventSeries(): CalendarApp.CalendarEventSeries

getEventType

From signature data Google source
  • getEventType(): CalendarApp.EventType

getGuestByEmail

From signature data Google source
  • getGuestByEmail(email: string): CalendarApp.EventGuest | null

getGuestList

From signature data Google source
  • getGuestList(): CalendarApp.EventGuest[]
  • getGuestList(includeOwner: boolean): CalendarApp.EventGuest[]

getId

From signature data Google source
  • getId(): string

getLastUpdated

From signature data Google source
  • getLastUpdated(): Date

getLocation

From signature data Google source
  • getLocation(): string

getMyStatus

From signature data Google source
  • getMyStatus(): CalendarApp.GuestStatus

getOriginalCalendarId

From signature data Google source
  • getOriginalCalendarId(): string

getPopupReminders

From signature data Google source
  • getPopupReminders(): number[]

getSmsReminders

From signature data Google source
  • getSmsReminders(): number[]

getStartTime

From signature data Google source
  • getStartTime(): Date

getTag

From signature data Google source
  • getTag(key: string): string

getTitle

From signature data Google source
  • getTitle(): string

getTransparency

From signature data Google source
  • getTransparency(): CalendarApp.EventTransparency

getVisibility

From signature data Google source
  • getVisibility(): CalendarApp.Visibility

guestsCanInviteOthers

From signature data Google source
  • guestsCanInviteOthers(): boolean

guestsCanModify

From signature data Google source
  • guestsCanModify(): boolean

guestsCanSeeGuests

From signature data Google source
  • guestsCanSeeGuests(): boolean

isAllDayEvent

From signature data Google source
  • isAllDayEvent(): boolean

isOwnedByMe

From signature data Google source
  • isOwnedByMe(): boolean

isRecurringEvent

From signature data Google source
  • isRecurringEvent(): boolean

removeAllReminders

From signature data Google source
  • removeAllReminders(): CalendarApp.CalendarEvent

removeGuest

From signature data Google source
  • removeGuest(email: string): CalendarApp.CalendarEvent

resetRemindersToDefault

From signature data Google source
  • resetRemindersToDefault(): CalendarApp.CalendarEvent

setAllDayDate

From signature data Google source
  • setAllDayDate(date: Date): CalendarApp.CalendarEvent

setAllDayDates

From signature data Google source
  • setAllDayDates(startDate: Date, endDate: Date): CalendarApp.CalendarEvent

setAnyoneCanAddSelf

From signature data Google source
  • setAnyoneCanAddSelf(anyoneCanAddSelf: boolean): CalendarApp.CalendarEvent

setColor

From signature data Google source
  • setColor(color: string): CalendarApp.CalendarEvent

setDescription

From signature data Google source
  • setDescription(description: string): CalendarApp.CalendarEvent

setGuestsCanInviteOthers

From signature data Google source
  • setGuestsCanInviteOthers(guestsCanInviteOthers: boolean): CalendarApp.CalendarEvent

setGuestsCanModify

From signature data Google source
  • setGuestsCanModify(guestsCanModify: boolean): CalendarApp.CalendarEvent

setGuestsCanSeeGuests

From signature data Google source
  • setGuestsCanSeeGuests(guestsCanSeeGuests: boolean): CalendarApp.CalendarEvent

setLocation

From signature data Google source
  • setLocation(location: string): CalendarApp.CalendarEvent

setMyStatus

From signature data Google source
  • setMyStatus(status: CalendarApp.GuestStatus): CalendarApp.CalendarEvent

setTag

From signature data Google source
  • setTag(key: string, value: string): CalendarApp.CalendarEvent

setTime

From signature data Google source
  • setTime(startTime: Date, endTime: Date): CalendarApp.CalendarEvent

setTitle

From signature data Google source
  • setTitle(title: string): CalendarApp.CalendarEvent

setTransparency

From signature data Google source
  • setTransparency(transparency: CalendarApp.EventTransparency): CalendarApp.CalendarEvent

setVisibility

From signature data Google source
  • setVisibility(visibility: CalendarApp.Visibility): CalendarApp.CalendarEvent

Need the whole workflow?

Return to a task guide

Task guides cover setup, permissions, expected results, and troubleshooting as well as object methods.

Browse Google Calendar tasks