Calendar Service

Calendar

This service allows a script to access and modify the user's Google Calendar, including additional calendars that the user is subscribed to.

Classes

Name Brief description
Calendar Represents a calendar that the user owns or is subscribed to.
Calendar App Allows a script to read and update the user's Google Calendar.
Calendar Event Represents a single calendar event.
Calendar Event Series Represents a series of events (a recurring event).
Color An enum representing the named colors available in the Calendar service.
Event Color An enum representing the named event colors available in the Calendar service.
Event Guest Represents a guest of an event.
Event Recurrence Represents the recurrence settings for an event series.
Event Transparency An enum representing the transparency of an event.
Event Type An enum representing the type of an event.
Guest Status An enum representing the statuses a guest can have for an event.
Recurrence Rule Represents a recurrence rule for an event series.
Visibility An enum representing the visibility of an event.

Calendar

Methods

Method Return type Brief description
Calendar Event Creates a new all-day event.
Calendar Event Creates a new all-day event that can span multiple days.
Calendar Event Creates a new all-day event that can span multiple days.
Calendar Event Creates a new all-day event.
Calendar Event Series Creates a new all-day event series.
Calendar Event Series Creates a new all-day event series.
Calendar Event Creates a new event.
Calendar Event Creates a new event.
Calendar Event Creates an event from a free-form description.
Calendar Event Series Creates a new event series.
Calendar Event Series Creates a new event series.
void Deletes the calendar permanently.
String Gets the color of the calendar.
String Gets the description of the calendar.
Calendar Event Gets the event with the given ID.
Calendar Event Series Gets the event series with the given ID.
Calendar Event[] Gets all events that occur within a given time range.
Calendar Event[] Gets all events that occur within a given time range and meet the specified criteria.
Calendar Event[] Gets all events that occur on a given day.
Calendar Event[] Gets all events that occur on a given day and meet specified criteria.
String Gets the ID of the calendar.
String Gets the name of the calendar.
String Gets the time zone of the calendar.
Boolean Determines whether the calendar is hidden in the user interface.
Boolean Determines whether the calendar is the primary calendar for the effective user.
Boolean Determines whether the calendar is owned by you.
Boolean Determines whether the calendar's events are displayed in the user interface.
Calendar Sets the color of the calendar.
Calendar Sets the description of a calendar.
Calendar Sets whether the calendar is visible in the user interface.
Calendar Sets the name of the calendar.
Calendar Sets whether the calendar's events are displayed in the user interface.
Calendar Sets the time zone of the calendar.
void Unsubscribes the user from a calendar.

Calendar App

Properties

Property Type Description
Color
Color An enum representing the named colors available in the Calendar service.
Event Color
Event Color An enum representing the named event colors available in the Calendar service.
Event Transparency
Event Transparency The Event Transparency enumeration.
Event Type
Event Type The Event Type enumeration.
Guest Status
Guest Status An enum representing the statuses a guest can have for an event.
Month
Month An enum representing the months of the year.
Visibility
Visibility An enum representing the visibility of an event.
Weekday
Weekday An enum representing the days of the week.

Methods

Method Return type Brief description
Calendar Event Creates a new all-day event.
Calendar Event Creates a new all-day event that can span multiple days.
Calendar Event Creates a new all-day event that can span multiple days.
Calendar Event Creates a new all-day event.
Calendar Event Series Creates a new all-day event series.
Calendar Event Series Creates a new all-day event series.
Calendar Creates a new calendar, owned by the user.
Calendar Creates a new calendar, owned by the user.
Calendar Event Creates a new event.
Calendar Event Creates a new event.
Calendar Event Creates an event from a free-form description.
Calendar Event Series Creates a new event series.
Calendar Event Series Creates a new event series.
Calendar[] Gets all calendars that the user owns or is subscribed to.
Calendar[] Gets all calendars that the user owns.
Calendar Gets the calendar with the given ID.
Calendar[] Gets all calendars with a given name that the user owns or is subscribed to.
String Gets the color of the calendar.
Calendar Gets the user's default calendar.
String Gets the description of the calendar.
Calendar Event Gets the event with the given ID.
Calendar Event Series Gets the event series with the given ID.
Calendar Event[] Gets all events that occur within a given time range.
Calendar Event[] Gets all events that occur within a given time range and meet the specified criteria.
Calendar Event[] Gets all events that occur on a given day.
Calendar Event[] Gets all events that occur on a given day and meet specified criteria.
String Gets the ID of the calendar.
String Gets the name of the calendar.
Calendar Gets the calendar with the given ID, if the user owns it.
Calendar[] Gets all calendars with a given name that the user owns.
String Gets the time zone of the calendar.
Boolean Determines whether the calendar is hidden in the user interface.
Boolean Determines whether the calendar is the primary calendar for the effective user.
Boolean Determines whether the calendar is owned by you.
Boolean Determines whether the calendar's events are displayed in the user interface.
Event Recurrence Creates a new recurrence object, which can be used to create rules for event recurrence.
Calendar Sets the color of the calendar.
Calendar Sets the description of a calendar.
Calendar Sets whether the calendar is visible in the user interface.
Calendar Sets the name of the calendar.
Calendar Sets whether the calendar's events are displayed in the user interface.
Calendar Sets the time zone of the calendar.
Calendar Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe.
Calendar Subscribes the user to the calendar with the given ID, if the user is allowed to subscribe.

Calendar Event

Methods

Method Return type Brief description
Calendar Event Adds a new email reminder to the event.
Calendar Event Adds a guest to the event.
Calendar Event Adds a new pop-up notification to the event.
Calendar Event Adds a new SMS reminder to the event.
Boolean Determines whether people can add themselves as guests to a Calendar event.
void Deletes a Calendar event.
Calendar Event Deletes a key/value tag from the event.
Date Gets the date on which this all-day calendar event ends.
Date Gets the date on which this all-day calendar event begins.
String[] Gets all keys for tags that have been set on the event.
String Returns the color of the calendar event.
String[] Gets the creators of an event.
Date Gets the date the event was created.
String Gets the description of the event.
Integer[] Gets the minute values for all email reminders for the event.
Date Gets the date and time at which this calendar event ends.
Calendar Event Series Gets the series of recurring events that this event belongs to.
Event Type Gets the Event Type of this event.
Event Guest Gets a guest by email address.
Event Guest[] Gets the guests for the event, not including the event owner.
Event Guest[] Gets the guests for the event, potentially including the event owners.
String Gets the unique iCalUID of the event.
Date Gets the date the event was last updated.
String Gets the location of the event.
Guest Status Gets the event status (such as attending or invited) of the effective user.
String Get the ID of the calendar where this event was originally created.
Integer[] Gets the minute values for all pop-up reminders for the event.
Integer[] Gets the minute values for all SMS reminders for the event.
Date Gets the date and time at which this calendar event begins.
String Gets a tag value of the event.
String Gets the title of the event.
Event Transparency Gets the transparency of the event.
Visibility Gets the visibility of the event.
Boolean Determines whether guests can invite other guests.
Boolean Determines whether guests can modify the event.
Boolean Determines whether guests can see other guests.
Boolean Determines whether this is an all-day event.
Boolean Determines whether you're the owner of the event.
Boolean Determines whether the event is part of an event series.
Calendar Event Removes all reminders from the event.
Calendar Event Removes a guest from the event.
Calendar Event Resets the reminders using the calendar's default settings.
Calendar Event Sets the date of the event.
Calendar Event Sets the dates of the event.
Calendar Event Sets whether non-guests can add themselves to the event.
Calendar Event Sets the color of the calendar event.
Calendar Event Sets the description of the event.
Calendar Event Sets whether guests can invite other guests.
Calendar Event Sets whether guests can modify the event.
Calendar Event Sets whether guests can see other guests.
Calendar Event Sets the location of the event.
Calendar Event Sets the event status (such as attending or invited) of the effective user.
Calendar Event Sets a key/value tag on the event, for storing custom metadata.
Calendar Event Sets the dates and times for the start and end of the event.
Calendar Event Sets the title of the event.
Calendar Event Sets the transparency of the event.
Calendar Event Sets the visibility of the event.

Calendar Event Series

Methods

Method Return type Brief description
Calendar Event Series Adds a new email reminder to the event.
Calendar Event Series Adds a guest to the event.
Calendar Event Series Adds a new pop-up notification to the event.
Calendar Event Series Adds a new SMS reminder to the event.
Boolean Determines whether people can add themselves as guests to a Calendar event.
void Deletes the event series.
Calendar Event Series Deletes a key/value tag from the event.
String[] Gets all keys for tags that have been set on the event.
String Returns the color of the calendar event.
String[] Gets the creators of an event.
Date Gets the date the event was created.
String Gets the description of the event.
Integer[] Gets the minute values for all email reminders for the event.
Event Type Gets the Event Type of this event.
Event Guest Gets a guest by email address.
Event Guest[] Gets the guests for the event, not including the event owner.
Event Guest[] Gets the guests for the event, potentially including the event owners.
String Gets the unique iCalUID of the event.
Date Gets the date the event was last updated.
String Gets the location of the event.
Guest Status Gets the event status (such as attending or invited) of the effective user.
String Get the ID of the calendar where this event was originally created.
Integer[] Gets the minute values for all pop-up reminders for the event.
Integer[] Gets the minute values for all SMS reminders for the event.
String Gets a tag value of the event.
String Gets the title of the event.
Event Transparency Gets the transparency of the event.
Visibility Gets the visibility of the event.
Boolean Determines whether guests can invite other guests.
Boolean Determines whether guests can modify the event.
Boolean Determines whether guests can see other guests.
Boolean Determines whether you're the owner of the event.
Calendar Event Series Removes all reminders from the event.
Calendar Event Series Removes a guest from the event.
Calendar Event Series Resets the reminders using the calendar's default settings.
Calendar Event Series Sets whether non-guests can add themselves to the event.
Calendar Event Series Sets the color of the calendar event.
Calendar Event Series Sets the description of the event.
Calendar Event Series Sets whether guests can invite other guests.
Calendar Event Series Sets whether guests can modify the event.
Calendar Event Series Sets whether guests can see other guests.
Calendar Event Series Sets the location of the event.
Calendar Event Series Sets the event status (such as attending or invited) of the effective user.
Calendar Event Series Sets the recurrence rules for an all-day event series.
Calendar Event Series Sets the recurrence rules for this event series.
Calendar Event Series Sets a key/value tag on the event, for storing custom metadata.
Calendar Event Series Sets the title of the event.
Calendar Event Series Sets the transparency of the event.
Calendar Event Series Sets the visibility of the event.

Color

Properties

Property Type Description
BLUE
Enum
Blue ( #2952A3 ).
BROWN
Enum
Brown ( #8D6F47 ).
CHARCOAL
Enum
Charcoal ( #4E5D6C ).
CHESTNUT
Enum
Chestnut ( #865A5A ).
GRAY
Enum
Gray ( #5A6986 ).
GREEN
Enum
Green ( #0D7813 ).
INDIGO
Enum
Indigo ( #5229A3 ).
LIME
Enum
Lime ( #528800 ).
MUSTARD
Enum
Mustard ( #88880E ).
OLIVE
Enum
Olive ( #6E6E41 ).
ORANGE
Enum
Orange ( #BE6D00 ).
PINK
Enum
Pink ( #B1365F ).
PLUM
Enum
Plum ( #705770 ).
PURPLE
Enum
Purple ( #7A367A ).
RED
Enum
Red ( #A32929 ).
RED_ORANGE
Enum
Red-Orange ( #B1440E ).
SEA_BLUE
Enum
Sea Blue ( #29527A ).
SLATE
Enum
Slate ( #4A716C ).
TEAL
Enum
Teal ( #28754E ).
TURQOISE
Enum
Turquoise ( #1B887A ).
YELLOW
Enum
Yellow ( #AB8B00 ).

Event Color

Properties

Property Type Description
PALE_BLUE
Enum
Pale Blue ( "1" ), referred to as "Peacock" in th Calendar UI.
PALE_GREEN
Enum
Pale Green ( "2" ), referred to as "Sage" in th Calendar UI.
MAUVE
Enum
Mauve ( "3" ),, referred to as "Grape" in th Calendar UI.
PALE_RED
Enum
Pale Red ( "4" ), referred to as "Flamingo" in th Calendar UI.
YELLOW
Enum
Yellow ( "5" ), referred to as "Banana" in th Calendar UI.
ORANGE
Enum
Orange ( "6" ), referred to as "Tangerine" in th Calendar UI.
CYAN
Enum
Cyan ( "7" ), referred to as "Lavender" in th Calendar UI.
GRAY
Enum
Gray ( "8" ), referred to as "Graphite" in th Calendar UI.
BLUE
Enum
Blue ( "9" ), referred to as "Blueberry" in th Calendar UI.
GREEN
Enum
Green ( "10" ), referred to as "Basil" in th Calendar UI.
RED
Enum
Red ( "11" ), referred to as "Tomato" in th Calendar UI.

Event Guest

Methods

Method Return type Brief description
Integer Gets the number of additional people that this guest has said are attending.
String Gets the email address of the guest.
Guest Status Gets the status of the guest for the event.
String Gets the name of the guest.

Event Recurrence

Methods

Method Return type Brief description
Recurrence Rule Adds a rule that excludes occurrences on a daily basis.
Recurrence Rule Adds a rule that causes the event to recur on a daily basis.
Event Recurrence Adds a rule that causes the event to recur on a specific date.
Event Recurrence Adds a rule that excludes an occurrence for a specific date.
Recurrence Rule Adds a rule that excludes occurrences on a monthly basis.
Recurrence Rule Adds a rule that causes the event to recur on a monthly basis.
Recurrence Rule Adds a rule that excludes occurrences on a weekly basis.
Recurrence Rule Adds a rule that causes the event to recur on a weekly basis.
Recurrence Rule Adds a rule that excludes occurrences on a yearly basis.
Recurrence Rule Adds a rule that causes the event to recur on a yearly basis.
Event Recurrence Sets the time zone for this recurrence.

Event Transparency

Properties

Property Type Description
OPAQUE
Enum The event does block time on the calendar.
TRANSPARENT
Enum The event does not block time on the calendar.

Event Type

Properties

Property Type Description
DEFAULT
Enum The event is a regular event.
BIRTHDAY
Enum The event is a special all-day event with an annual recurrence.
FOCUS_TIME
Enum The event is a focus-time event.
FROM_GMAIL
Enum The event is an event from Gmail.
OUT_OF_OFFICE
Enum The event is an out-of-office event.
WORKING_LOCATION
Enum The event is a working location event.

Guest Status

Properties

Property Type Description
INVITED
Enum The guest has been invited, but has not indicated whether they are attending.
MAYBE
Enum The guest has indicated they might attend.
NO
Enum The guest has indicated they are not attending.
OWNER
Enum The guest is the owner of the event.
YES
Enum The guest has indicated they are attending.

Recurrence Rule

Methods

Method Return type Brief description
Recurrence Rule Adds a rule that excludes occurrences on a daily basis.
Recurrence Rule Adds a rule that causes the event to recur on a daily basis.
Event Recurrence Adds a rule that causes the event to recur on a specific date.
Event Recurrence Adds a rule that excludes an occurrence for a specific date.
Recurrence Rule Adds a rule that excludes occurrences on a monthly basis.
Recurrence Rule Adds a rule that causes the event to recur on a monthly basis.
Recurrence Rule Adds a rule that excludes occurrences on a weekly basis.
Recurrence Rule Adds a rule that causes the event to recur on a weekly basis.
Recurrence Rule Adds a rule that excludes occurrences on a yearly basis.
Recurrence Rule Adds a rule that causes the event to recur on a yearly basis.
Recurrence Rule Configures the rule to only apply at this interval of the rule's time unit.
Recurrence Rule Configures the rule to only apply to a specific month.
Recurrence Rule Configures the rule to only apply to specific months.
Recurrence Rule Configures the rule to only apply to a specific day of the month.
Recurrence Rule Configures the rule to only apply to specific days of the month.
Recurrence Rule Configures the rule to only apply to a specific week of the year.
Recurrence Rule Configures the rule to only apply to a specific day of the week.
Recurrence Rule Configures the rule to only apply to specific days of the week.
Recurrence Rule Configures the rule to only apply to specific weeks of the year.
Recurrence Rule Configures the rule to only apply to a specific day of the year.
Recurrence Rule Configures the rule to only apply to specific days of the year.
Event Recurrence Sets the time zone for this recurrence.
Recurrence Rule Configures the rule to end after a given number of occurrences.
Recurrence Rule Configures the rule to end on a given date (inclusive).
Recurrence Rule Configures which day a week starts on, for the purposes of applying the rule.

Visibility

Properties

Property Type Description
CONFIDENTIAL
Enum The event is private.
DEFAULT
Enum Uses the default visibility for events on the calendar.
PRIVATE
Enum The event is private and only event attendees may view event details.
PUBLIC
Enum The event is public and event details are visible to all readers of the calendar.
Create a Mobile Website
View Site in Mobile | Classic
Share by: